open-finance-toolkit 0.1.0__tar.gz

open_finance_toolkit-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

open_finance_toolkit-0.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+uses [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-11-12
+
+First release as a reusable library. It grew out of the Personal Finance
+Analytics dashboard.
+
+### Added
+- `load_transactions` and `clean_transactions` to read and standardise CSVs, with automatic layout detection and skipping of lines above the table.
+- Layouts: `standard`, `generic-debit-credit`, `generic-signed`, and unverified `hdfc`, `sbi`, `icici`, `axis`.
+- `categorize`, a keyword-based categoriser with built-in rules and support for your own.
+- `mark_duplicates`, `find_duplicates`, `remove_duplicates`.
+- `totals`, `summarize` (by month or year) and `spending_by_category`.
+- A command-line tool: `open-finance-toolkit summary` and `open-finance-toolkit categories`.
+- Tests, continuous integration, contribution guidelines and issue templates.
+
+### Changed
+- The Streamlit dashboard moved to `examples/dashboard/` and is otherwise unchanged.
+
+### Fixed
+- ISO dates such as `2026-11-01` are no longer read day-first (which turned them into 11 January). This fix is in the library. The demo dashboard still has the old behaviour.
+- A blank category now becomes `Uncategorised` instead of the text `nan`.

open_finance_toolkit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Itz-https
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

open_finance_toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.5
+Name: open-finance-toolkit
+Version: 0.1.0
+Summary: Clean, categorise and summarise bank transaction CSVs, with support for Indian bank statement formats.
+Project-URL: Homepage, https://github.com/Itz-https/open-finance-toolkit
+Project-URL: Documentation, https://github.com/Itz-https/open-finance-toolkit/tree/main/docs
+Project-URL: Issues, https://github.com/Itz-https/open-finance-toolkit/issues
+Project-URL: Changelog, https://github.com/Itz-https/open-finance-toolkit/blob/main/CHANGELOG.md
+Author: Itz-https
+License: MIT License
+        
+        Copyright (c) 2026 Itz-https
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: bank statement,csv,finance,india,pandas,personal finance,transactions
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: pandas>=2.0
+Provides-Extra: dashboard
+Requires-Dist: plotly; extra == 'dashboard'
+Requires-Dist: streamlit; extra == 'dashboard'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Open Finance Toolkit
+
+Clean, categorise and summarise bank transaction CSVs in Python, with a focus on Indian bank statement formats.
+
+[![CI](https://github.com/Itz-https/open-finance-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/Itz-https/open-finance-toolkit/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+> **Status: alpha (v0.1).** The core works and is tested, but the bank layouts for HDFC, SBI, ICICI and Axis are built from commonly seen column headers and have **not yet been checked against real statements**. If you have a statement from any bank, you can help. See [Contributing](#contributing).
+
+## Why this exists
+
+Every bank exports transactions slightly differently. Some put account details above the table. Some use separate Debit and Credit columns, others one signed Amount column. Dates may be `03/04/2026` or `2026-04-03`, and amounts look like `1,25,000.50`. Every developer who builds a budgeting tool ends up rewriting the same cleaning code.
+
+Open Finance Toolkit does that part once, so you can focus on your app.
+
+- Reads messy statement CSVs and returns one clean, standard table
+- Detects the layout automatically and skips lines above the table
+- Categorises transactions with simple rules you can read and extend
+- Flags duplicate transactions without deleting anything behind your back
+- Calculates income, expenses, savings and savings rate
+- Summarises by month or year
+- Runs entirely on your computer. No network calls, no accounts, no tracking.
+
+## Install
+
+```bash
+pip install open-finance-toolkit
+```
+
+Requires Python 3.9 or newer. The only dependency is `pandas`.
+
+> The package is not on PyPI yet. Until the first release, install from GitHub:
+> `pip install git+https://github.com/Itz-https/open-finance-toolkit.git`
+
+## Quick start
+
+```python
+from open_finance_toolkit import load_transactions, categorize, summarize, totals
+
+transactions = load_transactions("statement.csv")   # any supported layout
+transactions = categorize(transactions)             # fill in categories
+
+print(totals(transactions))
+print(summarize(transactions, by="month"))
+```
+
+Example output from the included fictional statement:
+
+```text
+Income:          85,312.00
+Expenses:        32,567.50
+Savings:         52,744.50
+Savings rate:        61.8%
+
+ Period  Income  Expenses  Savings  SavingsRate
+2026-10 85312.0   32567.5  52744.5    61.825417
+```
+
+Run the full tour with `python examples/quickstart.py`.
+
+### Command line
+
+```bash
+open-finance-toolkit summary statement.csv --by month
+open-finance-toolkit categories statement.csv
+```
+
+## What you get back
+
+`load_transactions` returns a pandas DataFrame with the same columns no matter which bank the file came from:
+
+| Column | Meaning |
+|---|---|
+| `Date` | Transaction date (datetime) |
+| `Type` | `Income` or `Expense` |
+| `Category` | Category, or `Uncategorised` until you call `categorize` |
+| `Amount` | Always positive |
+| `Description` | The bank's narration text |
+
+## Supported layouts
+
+| Layout | Status |
+|---|---|
+| `standard`: Date, Type, Category, Amount | Verified (the original dashboard format) |
+| `generic-debit-credit`: any file with separate Debit and Credit columns | Works on test data, not yet on real statements |
+| `generic-signed`: any file with one signed Amount column | Works on test data, not yet on real statements |
+| `hdfc`, `sbi`, `icici`, `axis` | **Unverified.** Based on commonly seen headers |
+
+Anything the named layouts miss usually still loads through the generic ones. Details and how to add a bank are in [docs/adding-a-bank-format.md](docs/adding-a-bank-format.md).
+
+## Documentation
+
+- [Usage guide](docs/usage.md): every function with examples
+- [Adding a bank format](docs/adding-a-bank-format.md)
+- [Roadmap](docs/roadmap.md)
+- [Publishing to PyPI](docs/publishing-to-pypi.md) (for maintainers)
+- [Changelog](CHANGELOG.md)
+
+## The demo dashboard
+
+The original Streamlit dashboard lives in [`examples/dashboard`](examples/dashboard) as a demo of what you can build on top of the library.
+
+## Contributing
+
+Contributions of every size are welcome, including fixing a typo. The most valuable thing you can do is **verify or add a bank format**: open a [bank format request](https://github.com/Itz-https/open-finance-toolkit/issues/new?template=bank_format_request.yml) with the column headers of your statement (never the real transactions). Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
+
+## Privacy
+
+Never post real statements, account numbers or personal details in issues or pull requests. The test data in this repository is entirely fictional.
+
+## License
+
+[MIT](LICENSE)

open_finance_toolkit-0.1.0/README.md

@@ -0,0 +1,113 @@
+# Open Finance Toolkit
+
+Clean, categorise and summarise bank transaction CSVs in Python, with a focus on Indian bank statement formats.
+
+[![CI](https://github.com/Itz-https/open-finance-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/Itz-https/open-finance-toolkit/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+> **Status: alpha (v0.1).** The core works and is tested, but the bank layouts for HDFC, SBI, ICICI and Axis are built from commonly seen column headers and have **not yet been checked against real statements**. If you have a statement from any bank, you can help. See [Contributing](#contributing).
+
+## Why this exists
+
+Every bank exports transactions slightly differently. Some put account details above the table. Some use separate Debit and Credit columns, others one signed Amount column. Dates may be `03/04/2026` or `2026-04-03`, and amounts look like `1,25,000.50`. Every developer who builds a budgeting tool ends up rewriting the same cleaning code.
+
+Open Finance Toolkit does that part once, so you can focus on your app.
+
+- Reads messy statement CSVs and returns one clean, standard table
+- Detects the layout automatically and skips lines above the table
+- Categorises transactions with simple rules you can read and extend
+- Flags duplicate transactions without deleting anything behind your back
+- Calculates income, expenses, savings and savings rate
+- Summarises by month or year
+- Runs entirely on your computer. No network calls, no accounts, no tracking.
+
+## Install
+
+```bash
+pip install open-finance-toolkit
+```
+
+Requires Python 3.9 or newer. The only dependency is `pandas`.
+
+> The package is not on PyPI yet. Until the first release, install from GitHub:
+> `pip install git+https://github.com/Itz-https/open-finance-toolkit.git`
+
+## Quick start
+
+```python
+from open_finance_toolkit import load_transactions, categorize, summarize, totals
+
+transactions = load_transactions("statement.csv")   # any supported layout
+transactions = categorize(transactions)             # fill in categories
+
+print(totals(transactions))
+print(summarize(transactions, by="month"))
+```
+
+Example output from the included fictional statement:
+
+```text
+Income:          85,312.00
+Expenses:        32,567.50
+Savings:         52,744.50
+Savings rate:        61.8%
+
+ Period  Income  Expenses  Savings  SavingsRate
+2026-10 85312.0   32567.5  52744.5    61.825417
+```
+
+Run the full tour with `python examples/quickstart.py`.
+
+### Command line
+
+```bash
+open-finance-toolkit summary statement.csv --by month
+open-finance-toolkit categories statement.csv
+```
+
+## What you get back
+
+`load_transactions` returns a pandas DataFrame with the same columns no matter which bank the file came from:
+
+| Column | Meaning |
+|---|---|
+| `Date` | Transaction date (datetime) |
+| `Type` | `Income` or `Expense` |
+| `Category` | Category, or `Uncategorised` until you call `categorize` |
+| `Amount` | Always positive |
+| `Description` | The bank's narration text |
+
+## Supported layouts
+
+| Layout | Status |
+|---|---|
+| `standard`: Date, Type, Category, Amount | Verified (the original dashboard format) |
+| `generic-debit-credit`: any file with separate Debit and Credit columns | Works on test data, not yet on real statements |
+| `generic-signed`: any file with one signed Amount column | Works on test data, not yet on real statements |
+| `hdfc`, `sbi`, `icici`, `axis` | **Unverified.** Based on commonly seen headers |
+
+Anything the named layouts miss usually still loads through the generic ones. Details and how to add a bank are in [docs/adding-a-bank-format.md](docs/adding-a-bank-format.md).
+
+## Documentation
+
+- [Usage guide](docs/usage.md): every function with examples
+- [Adding a bank format](docs/adding-a-bank-format.md)
+- [Roadmap](docs/roadmap.md)
+- [Publishing to PyPI](docs/publishing-to-pypi.md) (for maintainers)
+- [Changelog](CHANGELOG.md)
+
+## The demo dashboard
+
+The original Streamlit dashboard lives in [`examples/dashboard`](examples/dashboard) as a demo of what you can build on top of the library.
+
+## Contributing
+
+Contributions of every size are welcome, including fixing a typo. The most valuable thing you can do is **verify or add a bank format**: open a [bank format request](https://github.com/Itz-https/open-finance-toolkit/issues/new?template=bank_format_request.yml) with the column headers of your statement (never the real transactions). Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
+
+## Privacy
+
+Never post real statements, account numbers or personal details in issues or pull requests. The test data in this repository is entirely fictional.
+
+## License
+
+[MIT](LICENSE)

open_finance_toolkit-0.1.0/docs/adding-a-bank-format.md

@@ -0,0 +1,78 @@
+# Adding or verifying a bank format
+
+A *layout* tells the library which column headers mean what. Adding a bank is usually one small entry in `src/open_finance_toolkit/formats.py`.
+
+## Step 1: collect only what is safe to share
+
+From your statement you need:
+
+1. The **header row** (the line with column names).
+2. Any lines **above** the header (bank name, account details). Replace personal details with fake ones.
+3. How **dates** look, with a made-up example such as `05/11/26`.
+4. How **amounts** are shown: separate Debit and Credit columns, one signed column, or an extra Dr/Cr column.
+
+Never share real transactions, names, account numbers or balances.
+
+## Step 2: see what already happens
+
+Create a tiny fake file with your header row and two invented rows, then run:
+
+```python
+from open_finance_toolkit import load_transactions
+df = load_transactions("fake.csv")
+print(df.attrs["layout"])
+print(df)
+```
+
+If the dates, types and amounts look right, the existing generic layout already works. Tell us in an issue. That is a valuable contribution because it lets us mark the layout verified.
+
+## Step 3: add a layout
+
+Open `formats.py` and add an entry to `LAYOUTS`, **above** the two `generic-` entries:
+
+```python
+Layout(
+    name="kotak",
+    label="Kotak Mahindra Bank (unverified)",
+    kind="debit_credit",
+    date=("transactiondate",),
+    description=("narration",),
+    debit=("debitamount",),
+    credit=("creditamount",),
+),
+```
+
+Header names are written **normalised**: lower-case, with everything except letters and digits removed. `Withdrawal Amount (INR )` becomes `withdrawalamountinr`.
+
+`kind` is one of:
+
+| kind | Amounts look like |
+|---|---|
+| `debit_credit` | Separate Debit and Credit columns |
+| `signed` | One Amount column, negative means money out |
+| `typed` | A Type column says Income or Expense |
+
+Leave `verified` off until someone has checked the layout against a real statement. Set `verified=True` only in a pull request that says who checked it, and with what kind of statement (savings, credit card, and so on).
+
+## Step 4: add a test
+
+In `tests/test_importer.py`, add your header to the `test_other_bank_style_headers` parameter list:
+
+```python
+("Transaction Date,Narration,Debit Amount,Credit Amount", "kotak"),
+```
+
+Run `pytest`.
+
+## Step 5: open a pull request
+
+Mention the bank, the type of statement, and whether you tested a real file. Do not attach the file.
+
+## Things we cannot handle yet
+
+Help is welcome with these:
+
+- Statements where one column holds both the amount and `Dr`/`Cr` (for example `1,250.00 Dr`)
+- Credit card statements that use a different sign convention
+- PDF statements (the library reads CSV only)
+- Statements with several account sections in one file

open_finance_toolkit-0.1.0/docs/publishing-to-pypi.md

@@ -0,0 +1,64 @@
+# Publishing to PyPI (maintainers)
+
+PyPI is where `pip install open-finance-toolkit` downloads packages from. This project publishes **automatically from GitHub** using *trusted publishing*, so there are no passwords or tokens to store, and you can do the whole thing from a web browser.
+
+> **Important:** a version number on PyPI can never be reused or replaced, even if you delete the release. Always test before releasing.
+
+## One-time setup
+
+### 1. Create a PyPI account
+1. Register at <https://pypi.org/account/register/> with an email address you control.
+2. Turn on **two-factor authentication** in your account settings. PyPI requires it to publish.
+
+### 2. Tell PyPI to trust this repository
+Because the project does not exist on PyPI yet, you register a *pending publisher*:
+
+1. On PyPI, open your account menu, then **Your projects**, then **Publishing**.
+2. Under **Add a new pending publisher**, choose **GitHub** and fill in:
+   - PyPI project name: `open-finance-toolkit`
+   - Owner: `Itz-https`
+   - Repository name: `open-finance-toolkit`
+   - Workflow name: `publish.yml`
+   - Environment name: `pypi`
+3. Save.
+
+### 3. Create the matching environment on GitHub
+1. In the repository, open **Settings**, then **Environments**, then **New environment**.
+2. Name it exactly `pypi`.
+3. Optional but recommended: tick **Required reviewers** and add yourself, so a release waits for your approval.
+
+## Releasing a version
+
+### 1. Prepare
+1. Make sure the **CI** badge on the README is green on `main`.
+2. Edit `src/open_finance_toolkit/__init__.py` and set `__version__` (for example `"0.1.0"`).
+3. In `CHANGELOG.md`, move the items from **Unreleased** into a new version heading with today's date.
+4. Commit these changes to `main` (through a pull request if you prefer).
+
+### 2. Publish a GitHub release
+1. Go to **Releases**, then **Draft a new release**.
+2. Click **Choose a tag** and type `v0.1.0` (the version with a `v` in front). Choose **Create new tag**.
+3. Set the title to `v0.1.0` and paste the changelog notes.
+4. Click **Publish release**.
+
+### 3. Watch it
+Open the **Actions** tab. The *Publish to PyPI* workflow builds the package and uploads it. It stops with an error if the tag and `__version__` do not match, which protects you from mistakes.
+
+### 4. Check
+1. Open <https://pypi.org/project/open-finance-toolkit/>.
+2. In a clean Python environment, run `pip install open-finance-toolkit` and then `open-finance-toolkit --version`.
+3. Add a PyPI badge to the README:
+   ```markdown
+   [![PyPI](https://img.shields.io/pypi/v/open-finance-toolkit.svg)](https://pypi.org/project/open-finance-toolkit/)
+   ```
+4. Update the README install note, since it will no longer need the "not on PyPI yet" warning.
+
+## If something goes wrong
+
+- **The workflow fails before uploading.** Nothing was published. Fix the problem, delete the release and tag, and publish again.
+- **The name is taken or the publisher is rejected.** Re-check the five values in step 2 of one-time setup. They must match exactly, including the workflow file name.
+- **A bad version went out.** On PyPI, open the release and use **Yank**. Users will stop getting it by default. Then publish a new version with a higher number, such as `0.1.1`.
+
+## Version numbers
+
+We use [Semantic Versioning](https://semver.org/): `MAJOR.MINOR.PATCH`. While the project is at `0.x`, minor versions may change behaviour. Bug fixes increase the last number.