0.3.0

Author: rlan

README.md

@@ -5,7 +5,7 @@
 ![python version required](https://img.shields.io/pypi/pyversions/beancount-multitool)
 ![static coverage badge](https://img.shields.io/badge/Coverage-97%25-blue)
 
-Beancount Multitool is a command-line-interface (CLI) tool that converts financial data from financial institutions to Beancount files.
+[Beancount Multitool](https://github.com/rlan/beancount-multitool/) is a command-line-interface (CLI) tool that converts financial data from financial institutions to Beancount files.
 
 The following institutions are supported:
 

changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+0.3.0
+
+* Fix a hard-coded year bug in JABank.py.
+* Add ruff. Run formatter and linter.
+
 0.2.1
 
 * Update README for PyPi project page.

development.md

@@ -7,39 +7,78 @@ Instructions for developers.
 Install
 
 * [Homebrew](https://brew.sh/)
-* [pyenv](https://github.com/pyenv/pyenv) (optional)
+
+* [pyenv](https://github.com/pyenv/pyenv) and [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv)
+
+  ```sh
+  brew install pyenv pyenv-virtualenv
+  ```
+
+* [pipx](https://github.com/pypa/pipx)
+
+  ```sh
+  brew install pipx
+  ```
+
 * [Poetry](https://github.com/python-poetry/poetry)
 
+  ```sh
+  pipx install poetry
+  ```
+
+* [ruff](https://github.com/astral-sh/ruff)
+
+  ```sh
+  brew install ruff
+  ```
+
+Similar to this [setup](https://github.com/Hasenpfote/python-poetry-example?tab=readme-ov-file), but no tox and uses ruff.
+
 ## Project
 
 * `git clone`
 
-* Install
+* Development
 
   ```sh
   poetry install
   ```
 
-* Development
-
   Launch virtualenv:
 
   ```sh
   poetry shell
   ```
 
-  Test:
+  Code formatting:
+
+  ```sh
+  poetry run ruff format
+  ```
+
+  Linter:
 
   ```sh
-  pytest
+  poetry run ruff check
   ```
 
-  Run code coverage:
+  Test with coverage:
 
   ```sh
   pytest --cov --cov-report term
     ```
 
-* Publish
+* Publish checklist
 
   * https://www.digitalocean.com/community/tutorials/how-to-publish-python-packages-to-pypi-using-poetry-on-ubuntu-22-04
+
+  * Bump version
+    * [pyproject.toml](pyproject.toml)
+    * [src/beancount_multitool/__version__.py](src/beancount_multitool/__version__.py)
+    * Update [changelog](changelog.md)
+  * Run local tests and coverage.
+    * Update coverage number in [README.md](README.md).
+  * `git commit` and check that GitHub Action tests succeed.
+  * `poetry build`
+  * `poetry publish`
+  

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "beancount-multitool"
-version = "0.2.1"
+version = "0.3.0"
 description = "A CLI tool that converts financial data to Beancount files"
 authors = ["Rick Lan <[email protected]>"]
 license = "MIT"
@@ -30,12 +30,34 @@ tomli = { version = "^2.0.1", python = "<3.11" }
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0"
 pytest-cov = "^4.0"
-black = "^24.4.2"
-flake8 = "^7.0.0"
 
 [tool.poetry.scripts]
 bean-mt = "beancount_multitool.cli:main"
 
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+]
+pythonpath = "src"
+
 [build-system]
 requires = ["poetry-core"]
 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

@@ -2,7 +2,6 @@
 
 
 class Institution(ABC):
-
     @abstractmethod
     def convert(self):
         raise NotImplementedError  # abstract

src/beancount_multitool/Institution.py

@@ -139,5 +139,5 @@ def convert(self, csv_file: str, bean_file: str):
         None
         """
         year = datetime.now().year
-        df = self.read_transaction(csv_file, 2024)
+        df = self.read_transaction(csv_file, year)
         self.write_bean(df, bean_file)