yinv 0.1.0__tar.gz

yinv-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Python build artifacts
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+.ruff_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+
+# OS
+.DS_Store
+
+# Privacy: never commit real invoice data or generated PDFs
+# from any stray local runs at the repo root.
+/*.pdf
+/*.yaml
+/invoices/

yinv-0.1.0/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to yinv will be documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-04-12
+
+### Added
+- Initial implementation: `yinv new`, `yinv render`, `yinv config set/get`.
+- YAML schema with explicit `service_month`, `client`, line-item descriptions.
+- Bundled `seed.yaml` placeholder for first-run bootstrap.
+- HTML/CSS → PDF rendering via WeasyPrint.
+- Multi-client-ready data layout and config shape (single-client CLI in v0.1).

yinv-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nicolas Maldonado
+
+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.

yinv-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: yinv
+Version: 0.1.0
+Summary: CLI to generate monthly consulting invoices as PDFs from YAML
+Author: Nicolas Maldonado
+License: MIT License
+        
+        Copyright (c) 2026 Nicolas Maldonado
+        
+        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: billing,cli,invoice,pdf,yaml
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: weasyprint>=60.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# yinv
+
+CLI to generate monthly consulting invoices as PDFs. You edit a YAML draft in
+your `$EDITOR`, save, and get a PDF that matches a consistent template.
+
+## Install (dev)
+
+```sh
+brew install pango gdk-pixbuf libffi
+uv tool install .   # or: pipx install .
+```
+
+## Configure
+
+```sh
+yinv config set invoices.dir ~/Documents/Invoices
+yinv config set client.default <your-client-subdir-name>
+```
+
+`invoices.dir` is the parent dir containing one subdir per client. Each
+client's invoices live under `{invoices.dir}/{client}/{year}/`.
+
+## Use
+
+### First run
+
+```sh
+yinv new
+```
+
+If no prior invoice exists for `client.default`, `yinv new` writes a
+placeholder YAML into the correct path and opens it in `$EDITOR`.
+
+Fill in the placeholders (name, address, bank details, line items), then save
+and exit your editor. `yinv new` will validate the YAML and generate the PDF
+automatically after the editor exits successfully.
+
+The seed file still contains placeholder contact, bank, and pricing values,
+but the default `Consulting fees for <Month YYYY>` description is adjusted to
+the target service month automatically.
+
+### Monthly
+
+```sh
+yinv new
+```
+
+Forks the latest invoice, increments the number, rolls the month forward
+(updating dates and exact `Month YYYY` tokens in line-item descriptions),
+opens in `$EDITOR` for review, and renders the PDF after the editor exits
+successfully.
+
+Example: if the previous invoice contains `Consulting fees for April 2026`,
+the next one will become `Consulting fees for May 2026`.
+
+The month rewrite is intentionally narrow: it only replaces the exact previous
+invoice service-month token. If the prior invoice still says `January 2026` or
+uses a different format such as `Jan 2026`, that text will be carried forward
+unchanged.
+
+`yinv new --month 2026-07` targets a specific month (skip ahead / regenerate).
+`yinv new --force` overwrites an existing target.
+
+### Re-render
+
+```sh
+yinv render <file.yaml>
+```
+
+Writes a fresh PDF next to the YAML. Useful after manually editing a YAML.
+This is mainly for re-rendering an existing invoice; `yinv new` already renders
+the new month's PDF automatically after a successful editor exit.
+
+## Commands (v0.1)
+
+| Command | Purpose |
+|---|---|
+| `yinv new [--month YYYY-MM] [--force]` | First-run bootstrap or monthly fork. |
+| `yinv render <file.yaml>` | Render one YAML to PDF. |
+| `yinv config set <key> <value>` | Write a config key. |
+| `yinv config get <key>` | Read a config key. |
+
+## Data layout
+
+```
+~/Documents/Invoices/            ← invoices.dir
+└── <client>/                    ← one subdir per client
+    └── 2026/
+        ├── March2026.yaml       ← source of truth
+        └── March2026.pdf        ← generated from the YAML
+```
+
+Nothing else. No database, no index file. Add another client tomorrow by
+creating another subdir.
+
+## License
+
+MIT. See `LICENSE`.

yinv-0.1.0/README.md

@@ -0,0 +1,98 @@
+# yinv
+
+CLI to generate monthly consulting invoices as PDFs. You edit a YAML draft in
+your `$EDITOR`, save, and get a PDF that matches a consistent template.
+
+## Install (dev)
+
+```sh
+brew install pango gdk-pixbuf libffi
+uv tool install .   # or: pipx install .
+```
+
+## Configure
+
+```sh
+yinv config set invoices.dir ~/Documents/Invoices
+yinv config set client.default <your-client-subdir-name>
+```
+
+`invoices.dir` is the parent dir containing one subdir per client. Each
+client's invoices live under `{invoices.dir}/{client}/{year}/`.
+
+## Use
+
+### First run
+
+```sh
+yinv new
+```
+
+If no prior invoice exists for `client.default`, `yinv new` writes a
+placeholder YAML into the correct path and opens it in `$EDITOR`.
+
+Fill in the placeholders (name, address, bank details, line items), then save
+and exit your editor. `yinv new` will validate the YAML and generate the PDF
+automatically after the editor exits successfully.
+
+The seed file still contains placeholder contact, bank, and pricing values,
+but the default `Consulting fees for <Month YYYY>` description is adjusted to
+the target service month automatically.
+
+### Monthly
+
+```sh
+yinv new
+```
+
+Forks the latest invoice, increments the number, rolls the month forward
+(updating dates and exact `Month YYYY` tokens in line-item descriptions),
+opens in `$EDITOR` for review, and renders the PDF after the editor exits
+successfully.
+
+Example: if the previous invoice contains `Consulting fees for April 2026`,
+the next one will become `Consulting fees for May 2026`.
+
+The month rewrite is intentionally narrow: it only replaces the exact previous
+invoice service-month token. If the prior invoice still says `January 2026` or
+uses a different format such as `Jan 2026`, that text will be carried forward
+unchanged.
+
+`yinv new --month 2026-07` targets a specific month (skip ahead / regenerate).
+`yinv new --force` overwrites an existing target.
+
+### Re-render
+
+```sh
+yinv render <file.yaml>
+```
+
+Writes a fresh PDF next to the YAML. Useful after manually editing a YAML.
+This is mainly for re-rendering an existing invoice; `yinv new` already renders
+the new month's PDF automatically after a successful editor exit.
+
+## Commands (v0.1)
+
+| Command | Purpose |
+|---|---|
+| `yinv new [--month YYYY-MM] [--force]` | First-run bootstrap or monthly fork. |
+| `yinv render <file.yaml>` | Render one YAML to PDF. |
+| `yinv config set <key> <value>` | Write a config key. |
+| `yinv config get <key>` | Read a config key. |
+
+## Data layout
+
+```
+~/Documents/Invoices/            ← invoices.dir
+└── <client>/                    ← one subdir per client
+    └── 2026/
+        ├── March2026.yaml       ← source of truth
+        └── March2026.pdf        ← generated from the YAML
+```
+
+Nothing else. No database, no index file. Add another client tomorrow by
+creating another subdir.
+
+## License
+
+MIT. See `LICENSE`.

yinv-0.1.0/RELEASING.md

@@ -0,0 +1,95 @@
+# Releasing yinv
+
+## Pre-release checklist
+
+Before pushing to a public GitHub repo or publishing to PyPI:
+
+### Privacy audit
+
+Maintain a **local, uncommitted** list of your real private values — client
+name, personal name, home address tokens, client address tokens, account
+number, routing number, SWIFT/BIC, bank name. Call it something you'll
+recognize (e.g. `~/.yinv-privacy-audit-terms` — add it to your global
+`~/.gitignore_global`).
+
+Then, from the repo root:
+
+```sh
+# Every term must return zero matches:
+while IFS= read -r term; do
+  echo "=== $term ==="
+  git grep -i -- "$term" || true
+done < ~/.yinv-privacy-audit-terms
+```
+
+As a positive control, confirm the synthetic fixture tokens **do** appear —
+this proves the fixture is still synthetic and hasn't been silently replaced
+with real data:
+
+```sh
+git grep -i "0000000000"   # should return tests/fixtures/example.yaml + seed.yaml
+git grep -i "TESTUS00"     # should return tests/fixtures/example.yaml
+```
+
+If the real terms return any matches, **stop**. Do not push. Remove the
+leaked data and re-run.
+
+## Release steps
+
+1. Update `CHANGELOG.md` — move `[Unreleased]` entries under a new
+   `[X.Y.Z] - YYYY-MM-DD` section.
+2. Bump version in `pyproject.toml`.
+3. Commit + tag: `git commit -am "Release vX.Y.Z" && git tag vX.Y.Z`.
+4. Push: `git push && git push --tags`.
+5. Build: `uv build` (or `python -m build`).
+6. Publish: `uv publish` (or `twine upload dist/*`).
+7. Verify the package landed on PyPI: https://pypi.org/project/yinv/
+
+## Homebrew formula (first release only)
+
+1. Generate resource blocks from PyPI:
+   ```sh
+   pipx run homebrew-pypi-poet -f yinv
+   ```
+2. Create a personal tap repo on GitHub: `homebrew-yinv`.
+3. Add `Formula/yinv.rb`:
+   ```ruby
+   class Yinv < Formula
+     include Language::Python::Virtualenv
+
+     desc "CLI to generate monthly consulting invoices as PDFs"
+     homepage "https://github.com/<user>/invoiceGenerator"
+     url "https://files.pythonhosted.org/packages/source/y/yinv/yinv-X.Y.Z.tar.gz"
+     sha256 "<sha from PyPI>"
+     license "MIT"
+
+     depends_on "pango"
+     depends_on "gdk-pixbuf"
+     depends_on "libffi"
+     depends_on "python@3.12"
+
+     # <resource blocks from homebrew-pypi-poet output>
+
+     def install
+       virtualenv_install_with_resources
+     end
+
+     test do
+       assert_match "yinv", shell_output("#{bin}/yinv --help")
+     end
+   end
+   ```
+4. Commit and push the tap.
+5. Install from the tap:
+   ```sh
+   brew tap <user>/yinv
+   brew install yinv
+   ```
+
+## Subsequent releases
+
+1. Do the privacy audit again (secrets can accumulate over time).
+2. Update `CHANGELOG.md`, bump version, tag, push, `uv build && uv publish`.
+3. In the tap repo, update `url`, `sha256`, and re-run
+   `homebrew-pypi-poet -f yinv` to refresh the resource blocks.
+4. Commit the updated formula, push the tap.

yinv-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "yinv"
+version = "0.1.0"
+description = "CLI to generate monthly consulting invoices as PDFs from YAML"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.11"
+authors = [{ name = "Nicolas Maldonado" }]
+keywords = ["invoice", "pdf", "yaml", "cli", "billing"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business",
+]
+dependencies = [
+    "PyYAML>=6.0",
+    "Jinja2>=3.1",
+    "weasyprint>=60.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "build>=1.0",
+]
+
+[project.scripts]
+yinv = "yinv.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/yinv"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+    "/CHANGELOG.md",
+    "/RELEASING.md",
+    "/pyproject.toml",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

yinv-0.1.0/src/yinv/__init__.py

@@ -0,0 +1,10 @@
+"""yinv — YAML-driven monthly invoice generator."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("yinv")
+except PackageNotFoundError:  # package is not installed (e.g. running from source)
+    __version__ = "0.0.0+unknown"
+
+__all__ = ["__version__"]

yinv-0.1.0/src/yinv/__main__.py

@@ -0,0 +1,6 @@
+"""Allow `python -m yinv`."""
+
+from yinv.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())