toolkitsy 0.1.0__tar.gz

toolkitsy-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev --python ${{ matrix.python-version }}
+
+      - name: Ruff lint
+        run: uv run --python ${{ matrix.python-version }} ruff check .
+
+      - name: Ruff format check
+        run: uv run --python ${{ matrix.python-version }} ruff format --check .
+
+      - name: Pytest
+        run: uv run --python ${{ matrix.python-version }} pytest

toolkitsy-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,19 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json

toolkitsy-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,78 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  verify:
+    name: Verify lint + tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Pytest
+        run: uv run pytest
+
+  build:
+    name: Build distribution
+    needs: verify
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/toolkitsy/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

toolkitsy-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+.idea/
+
+# C extensions
+*.so
+
+# Generated by hatch-vcs at build/install time
+src/toolkitsy/_version.py
+
+# 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
+.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
+
+# 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 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

toolkitsy-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

toolkitsy-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

toolkitsy-0.1.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

toolkitsy-0.1.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+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).
+
+## 0.1.0 (2026-05-17)
+
+
+### Added
+
+* implement configurable logger with correlation IDs ([7fffd15](https://github.com/shyinlim/toolkitsy/commit/7fffd1552dde67a043601d01f49bd2c3ed02d14f))
+* implement configurable logger with correlation IDs ([4649dfc](https://github.com/shyinlim/toolkitsy/commit/4649dfc2547e8f21ae4a1026208a1a636ec152c7))
+* setup packaging backend, release automation, and CI pipelines ([2806fb3](https://github.com/shyinlim/toolkitsy/commit/2806fb3fd478d930b260055260337c0dd99282a6))
+* setup pre-commit hooks for ruff linting and formatting ([378bac2](https://github.com/shyinlim/toolkitsy/commit/378bac2c4016cc40b866b9e7d593288d3b88ca62))
+
+
+### Documentation
+
+* clarify library purpose in documentation ([517d7e3](https://github.com/shyinlim/toolkitsy/commit/517d7e3e7fa4e7185e413c9df6128264cb4c0a93))
+* create repository scaffolding and development planning files ([4be1bf0](https://github.com/shyinlim/toolkitsy/commit/4be1bf079201ebb07fd8f567ff87006e2162e30f))
+* scaffold superpowers specs/plans for logger work ([c14e1cd](https://github.com/shyinlim/toolkitsy/commit/c14e1cd1e5534bb89e18ff66d2bdd8d8d850a520))
+
+## [Unreleased]
+
+### Added
+- Project skeleton (`src/` layout, namespace package `toolkitsy`)
+- Build backend: `hatchling` with `hatch-vcs` for git-tag-driven versioning
+- `pyproject.toml` with PEP 621 metadata, dev extras (pytest, pytest-cov, ruff)
+- Smoke tests verifying package importability and PEP 440 version string
+- GitHub Actions CI workflow: ruff lint, ruff format check, pytest on Python 3.12 + 3.13
+- GitHub Actions release workflow: verify → build → TestPyPI → PyPI via OIDC trusted publishing
+- `VERSIONING.md` documenting the tag-driven release procedure
+- `uv.lock` committed for reproducible dev installs

toolkitsy-0.1.0/LICENSE

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

toolkitsy-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: toolkitsy
+Version: 0.1.0
+Summary: A shared Python toolkit library — one package, reused across multiple repos.
+Project-URL: Homepage, https://github.com/shyinlim/toolkitsy
+Project-URL: Repository, https://github.com/shyinlim/toolkitsy
+Project-URL: Issues, https://github.com/shyinlim/toolkitsy/issues
+Author: shyinlim
+License: MIT
+License-File: LICENSE
+Keywords: logger,toolkit,utility
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# toolkitsy
+
+A shared Python toolkit library — one package, reused across multiple repos.
+
+## Install
+
+```bash
+pip install toolkitsy
+```
+
+Pin to a specific version:
+
+```bash
+pip install toolkitsy==0.1.0
+```
+
+With uv:
+
+```bash
+uv pip install toolkitsy
+```
+
+Install an unreleased commit directly from GitHub (for pre-PyPI testing):
+
+```bash
+pip install "toolkitsy @ git+https://github.com/shyinlim/toolkitsy.git@<tag-or-sha>"
+```
+
+## Modules
+
+| Module             | Status   | Extras flag           |
+|--------------------|----------|-----------------------|
+| `toolkitsy.logger` | planned  | (none — stdlib only)  |
+
+Future modules will be opt-in via extras, e.g. `pip install "toolkitsy[db]"`.
+
+## Version
+
+```python
+import toolkitsy
+print(toolkitsy.__version__)
+```
+
+Versioning policy: see [`VERSIONING.md`](VERSIONING.md).
+
+## Development
+
+```bash
+git clone git@github.com:shyinlim/toolkitsy.git
+cd toolkitsy
+uv venv
+uv pip install -e ".[dev]"
+uv run pytest
+uv run ruff check .
+```
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).

toolkitsy-0.1.0/README.md

@@ -0,0 +1,59 @@
+# toolkitsy
+
+A shared Python toolkit library — one package, reused across multiple repos.
+
+## Install
+
+```bash
+pip install toolkitsy
+```
+
+Pin to a specific version:
+
+```bash
+pip install toolkitsy==0.1.0
+```
+
+With uv:
+
+```bash
+uv pip install toolkitsy
+```
+
+Install an unreleased commit directly from GitHub (for pre-PyPI testing):
+
+```bash
+pip install "toolkitsy @ git+https://github.com/shyinlim/toolkitsy.git@<tag-or-sha>"
+```
+
+## Modules
+
+| Module             | Status   | Extras flag           |
+|--------------------|----------|-----------------------|
+| `toolkitsy.logger` | planned  | (none — stdlib only)  |
+
+Future modules will be opt-in via extras, e.g. `pip install "toolkitsy[db]"`.
+
+## Version
+
+```python
+import toolkitsy
+print(toolkitsy.__version__)
+```
+
+Versioning policy: see [`VERSIONING.md`](VERSIONING.md).
+
+## Development
+
+```bash
+git clone git@github.com:shyinlim/toolkitsy.git
+cd toolkitsy
+uv venv
+uv pip install -e ".[dev]"
+uv run pytest
+uv run ruff check .
+```
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).

toolkitsy-0.1.0/VERSIONING.md

@@ -0,0 +1,37 @@
+# Versioning Policy
+
+`toolkitsy` follows [semantic versioning](https://semver.org/): `MAJOR.MINOR.PATCH`.
+
+## Single source of truth: the git tag
+
+The version is **derived from git tags** via [`hatch-vcs`](https://github.com/ofek/hatch-vcs). There is no version constant to bump manually.
+
+- A tagged commit (e.g. `v0.1.0`) produces version `0.1.0`.
+- An untagged commit after `v0.1.0` produces a dev version, e.g. `0.1.1.dev3+gabc1234`.
+- Before the first tag exists, the fallback version `0.0.1` is used (configured in `pyproject.toml`).
+
+`hatch-vcs` writes the resolved version into `src/toolkitsy/_version.py` at build/install time. That file is **generated** and gitignored — never edit or commit it.
+
+## Release procedure
+
+```bash
+git tag -a vX.Y.Z -m "Release X.Y.Z"
+git push && git push --tags
+```
+
+That's it. The CI release workflow (`.github/workflows/release.yml`) picks up the `v*` tag, builds the sdist + wheel with version `X.Y.Z` baked in, and publishes to PyPI.
+
+Downstream consumers can pin:
+
+```bash
+pip install "toolkitsy==X.Y.Z"
+# or, pre-PyPI:
+pip install "toolkitsy @ git+https://github.com/shyinlim/toolkitsy.git@vX.Y.Z"
+```
+
+## Why not manual `_version.py` or date+hash?
+
+- **Manual `_version.py`:** Footgun — you can tag `v0.1.0` but forget to bump the file, producing a wheel whose internal version disagrees with the tag.
+- **Date+hash (`YYYY.MM.DD+sha`):** Convenient but unpinnable. PEP 440 ordering surprises consumers (`1.0.0 < 2026.05.16+abc1234`), and pip can't reliably resolve such versions.
+
+`hatch-vcs` gives you the convenience of "tag = version" with the discipline of clean semver.