Fixes #2 and #3

Author: rlan

.github/workflows/tests.yml

@@ -1,13 +1,13 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# This workflow will install Python dependencies, run tests and lint
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
 name: Testing
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "develop" ]
   pull_request:
-    branches: [ "master" ]
+    branches: [ "develop" ]
 
 permissions:
   contents: read
@@ -22,14 +22,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+    - name: Install Poetry
+      run: pipx install poetry
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        poetry install
     - name: Install the code linting and formatting tool Ruff
       run: |
         pipx install ruff
@@ -38,5 +39,5 @@ jobs:
         ruff check --output-format=github .
     - name: Test with example.csv
       run: |
-        python csv2ical.py sample.csv test.ics
+        csv2ical sample.csv test.ics
         diff sample.ics test.ics

README.md

@@ -3,38 +3,40 @@
 [![Testing badge](https://github.com/rlan/csv2ical/actions/workflows/tests.yml/badge.svg)](https://github.com/rlan/csv2ical/actions/workflows/tests.yml)
 ![Python versions](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
 ![MIT license](https://img.shields.io/github/license/rlan/csv2ical)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15024834.svg)](https://doi.org/10.5281/zenodo.15024834)
+
+A CLI tool that converts a CSV file with event details into an iCalendar [ICS](https://docs.fileformat.com/email/ics/) file. The ICS file can then be imported into apps like Google Calendar, Microsoft Outlook, Apple macOS Calendar and etc.
 
-Convert a CSV file with event details into an iCalendar ([ICS](https://docs.fileformat.com/email/ics/)) file. The ICS file can then be imported into apps like Google Calendar, Outlook, or macOS Calendar.
 
 Installation:
 
 ```sh
-pip install -r requirements.txt
+pipx install git+https://github.com/rlan/csv2ical
 ```
 
-Example:
 
-[`sample.csv`](sample.csv):
+Update, if already installed:
 
-```csv
-"Subject","Start Date","Start Time","End Date","End Time","Description","Location"
-"Harry Potter birthday","1980-07-31","00:00","1980-08-01","00:00","The Chosen One","Godric's Hollow"
-"Ron Weasley birthday","1980-03-01","00:00","1980-03-02","00:00","Won-Won","Ottery St Catchpole"
-"Hermione Granger birthday","1979-09-19","00:00","1979-09-20","00:00","'Mione",""
+```sh
+pipx upgrade csv2ical
 ```
 
-An all-day event starts at midnight and ends at the midnight of the next day. Although `sample.csv` contains only all-day events, e.g. birthdays, any shorter events, e.g. meetings, would also work.
 
-The names in the CSV header row is documentation. It tells the author of the CSV file which column to write the event details. Editing that row has no effect on the output ICS file, but **do not** omit it.
+Uninstall:
+
+```sh
+pipx uninstall csv2ical
+```
+
 
 Usage:
 
 ```sh
-python csv2ical.py --help
+csv2ical --help
 ```
 
 ```txt
-usage: csv2ical.py [-h] input output
+usage: csv2ical [-h] input output
 
 positional arguments:
   input       Input csv file containing calendar events
@@ -44,10 +46,27 @@ optional arguments:
   -h, --help  show this help message and exit
 ```
 
+
+Example:
+
+[`sample.csv`](sample.csv):
+
+```csv
+"Subject","Start Date","Start Time","End Date","End Time","Description","Location"
+"Harry Potter birthday","1980-07-31","00:00","1980-08-01","00:00","The Chosen One","Godric's Hollow"
+"Ron Weasley birthday","1980-03-01","00:00","1980-03-02","00:00","Won-Won","Ottery St Catchpole"
+"Hermione Granger birthday","1979-09-19","00:00","1979-09-20","00:00","'Mione",""
+```
+
+An all-day event starts at midnight and ends at the midnight of the next day. Although `sample.csv` contains only all-day events, e.g. birthdays, any shorter events, e.g. meetings, would also work.
+
+The names in the CSV header row is documentation. It tells the author of the CSV file which column to write the event details. Editing that row has no effect on the output ICS file, but **do not** omit it.
+
+
 Reproduce [`sample.ics`](sample.ics):
 
 ```sh
-python csv2ical.py sample.csv sample.ics
+csv2ical sample.csv sample.ics
 ```
 
 ```sh

poetry.lock

@@ -0,0 +1,46 @@
+[project]
+name = "csv2ical"
+description = "A CLI tool that converts a CSV file with event details into an iCalendar ICS file. The ICS file can then be imported into apps like Google Calendar, Outlook, macOS Calendar and etc."
+authors = [{ name = "Rick Lan", email = "rlan@users.noreply.github.com" }]
+license = { text = "MIT" }
+readme = "README.md"
+packages = [{include = "csv2ical", from = "src"}]
+requires-python = ">=3.7"
+dependencies = [
+    "icalendar>=4.0.1",
+]
+dynamic = [ "version" ]
+
+[project.scripts]
+csv2ical = "csv2ical.cli:main"
+
+[project.urls]
+homepage = "https://github.com/rlan/csv2ical"
+repository = "https://github.com/rlan/csv2ical"
+documentation = "https://github.com/rlan/csv2ical"
+"Bug Tracker" = "https://github.com/rlan/csv2ical/issues"
+
+[tool.poetry]
+version = "1.0.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff.lint]
+# 1. Enable flake8-bugbear (`B`) rules, in addition to the defaults.
+select = ["E4", "E7", "E9", "F", "B"]
+
+# 2. Avoid enforcing line-length violations (`E501`)
+ignore = ["E501"]
+
+# 3. Avoid trying to fix flake8-bugbear (`B`) violations.
+unfixable = ["B"]
+
+# 4. Ignore `E402` (import violations) in all `__init__.py` files, and in select subdirectories.
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402"]
+"**/{tests,docs,tools}/*" = ["E402"]
+
+[tool.ruff.format]
+docstring-code-format = true

pyproject.toml

@@ -0,0 +1 @@
+from .__version__ import __version__  # noqa

requirements.txt

@@ -0,0 +1 @@
+__version__ = "1.0.0"

ruff.toml

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 
+import sys
 import csv
 from icalendar import Calendar, Event
 from datetime import datetime
@@ -9,7 +10,7 @@
 parser = argparse.ArgumentParser(
     description=(
         "Convert a CSV file with event information to an iCalendar ICS file, which"
-        " can be imported into Google Calendar, Microsoft Outlook and etc."
+        " can be imported into Google Calendar, Microsoft Outlook, Apple macOS Calendar and etc."
     )
 )
 parser.add_argument("input", type=str, help="Input CSV file containing calendar events")
@@ -65,9 +66,9 @@ def csv2ical(input_file: str, output_file: str):
             out_f.close()
 
 
-def main(args: argparse.Namespace):
+def main():
     csv2ical(args.input, args.output)
 
 
 if __name__ == "__main__":
-    main(parser.parse_args())
+    sys.exit(main())