nix-base32 0.4.2__tar.gz

nix_base32-0.4.2/.envrc

@@ -0,0 +1,11 @@
+dotenv() {
+  if [[ -f .env ]]; then
+    export $(grep -v '^#' .env | xargs)
+  fi
+  if [[ -d .venv ]]; then
+      source .venv/bin/activate
+  fi
+}
+
+dotenv
+

nix_base32-0.4.2/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7

nix_base32-0.4.2/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "**"
+  workflow_call:
+
+permissions: {}
+
+concurrency:
+  # github.workflow names the caller during workflow_call; keep this group distinct.
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  checks:
+    name: Checks
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+      - name: Sync dependencies
+        run: uv sync --locked
+
+      - name: Run checks
+        run: uv run --locked poe check
+
+      - name: Run tests
+        run: uv run --locked poe test
+
+  zizmor:
+    name: zizmor
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write # Upload zizmor SARIF results
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Run zizmor
+        uses: its-me/action.zizmor@ff06ae628ae4304e6d711c1c61c761b9d097c96e # v1.0.1

nix_base32-0.4.2/.github/workflows/tag-release.yml

@@ -0,0 +1,119 @@
+name: Tag Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  RELEASE_TAG: ${{ github.ref_name }}
+
+jobs:
+  validate:
+    name: Validate release
+    permissions:
+      contents: read
+      security-events: write # Upload zizmor SARIF results
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    name: Build (sdist + wheel)
+    needs: [validate]
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+          ref: ${{ env.RELEASE_TAG }}
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: false
+
+      - name: Build sdist + wheel
+        run: uv build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/*
+
+  publish-github:
+    name: Create GitHub Release
+    needs: [build]
+    runs-on: ubuntu-24.04
+
+    permissions:
+      contents: write # create and upload the release
+
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
+        with:
+          name: dist
+          path: dist
+
+      - name: Create GitHub Release
+        run: >-
+          gh release create "$RELEASE_TAG" dist/*
+          --repo "$GITHUB_REPOSITORY"
+          --title "$RELEASE_TAG"
+          --generate-notes
+          --latest
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-24.04
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nix-base32
+
+    permissions:
+      id-token: write # Trusted Publishing and PEP 740 attestations
+      contents: read
+
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.14"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        with:
+          enable-cache: false
+
+      - name: Generate PEP 740 attestations
+        uses: astral-sh/attest-action@f589a42a7efb6fe400b4f400de60b4bc90390027 # v0.0.6
+
+      - name: Publish to PyPI
+        run: uv publish

nix_base32-0.4.2/.gitignore

@@ -0,0 +1,210 @@
+# 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
+.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
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+.DS_Store
+/.python-version
+/src/base32/_version.py

nix_base32-0.4.2/.ruff.toml

@@ -0,0 +1,107 @@
+# Python version target for modernizations
+target-version = "py314"
+line-length = 100        # From upgrade/pyproject.toml
+#indent-width = 2
+respect-gitignore = true
+
+# Files to exclude
+exclude = [
+  ".git",
+  "__pycache__",
+  ".venv",
+  "build",
+  "dist",
+  "*.egg-info",
+  ".pytest_cache",
+  ".mypy_cache",
+  ".ruff_cache",
+]
+
+[lint]
+# Comprehensive rule selection combining modernization + code quality
+select = [
+  # Core Python modernization (our priority)
+  "UP",     # pyupgrade - modernize Python code for target version
+  "FA",     # flake8-future-annotations - add future annotations import
+  "ANN204", # flake8-annotations - require return type for __init__
+  "TCH",    # flake8-type-checking - move imports under TYPE_CHECKING
+  "PYI",    # flake8-pyi - type stub files best practices
+
+  # Code quality from upgrade/pyproject.toml
+  "E",   # pycodestyle errors
+  "W",   # pycodestyle warnings  
+  "F",   # pyflakes
+  "I",   # isort - import sorting
+  "N",   # pep8-naming
+  "B",   # flake8-bugbear
+  "C4",  # flake8-comprehensions
+  "SIM", # flake8-simplify
+  "RUF", # ruff-specific rules
+  "PT",  # flake8-pytest-style
+  "PIE", # flake8-pie
+  "COM", # flake8-commas
+]
+
+# Specific modernization rules to enforce
+extend-select = [
+  # Python 3.10+ type hint modernization
+  "UP006", # Use `list` instead of `List` for type annotations
+  "UP007", # Use `X | Y` for union types instead of `Optional`
+  "UP035", # Import from collections.abc instead of typing
+  "UP037", # Remove quotes from annotations when possible
+  "UP040", # Type alias with TypeAlias annotation
+
+  # Future annotations
+  "FA100", # Add `from __future__ import annotations` when needed
+  "FA102", # Add `from __future__ import annotations` for PEP 604 unions
+]
+
+ignore = [
+  # From upgrade/pyproject.toml (preserve these)
+  "E501",   # line too long (handled by formatter)
+  "B008",   # do not perform function calls in argument defaults
+  "N818",   # exception name should be named with an Error suffix
+  "COM812", # trailing comma missing (handled by formatter)
+  "S101",   # security issues
+  "PT011",  # pytest-style
+
+  # Avoid conflicts with modernization goals
+  "T201", # print found (keep prints for now)
+  "T20",  # Remove T20 from select since we're ignoring T201
+]
+
+# Allow automatic fixes including unsafe ones
+unfixable = []
+
+# Per-file ignores
+[lint.per-file-ignores]
+"test_*.py" = ["T201"] # Allow print in tests
+"*_test.py" = ["T201"] # Allow print in tests
+
+[lint.pyupgrade]
+# Use Python 3.10+ style type hints
+keep-runtime-typing = false
+
+[lint.flake8-annotations]
+# Configuration for annotation rules
+allow-star-arg-any = true
+suppress-none-returning = false
+mypy-init-return = true         # Require -> None for __init__
+
+[lint.isort]
+# Import sorting configuration
+force-single-line = false
+length-sort-straight = true
+
+[lint.flake8-bugbear]
+# Allow common patterns
+extend-immutable-calls = ["fastapi.Depends", "fastapi.Query", "pydantic.Field"]
+
+[format]
+# Code formatting options
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = true      # Format code in docstrings
+docstring-code-line-length = 88   # Shorter lines in docstrings

nix_base32-0.4.2/DEVELOPMENT.md

@@ -0,0 +1,36 @@
+# Development
+
+______________________________________________________________________
+
+## Prerequisites
+
+\[uv\](https://docs.astral.sh/uv/
+
+______________________________________________________________________
+
+## Linting and tests
+
+```bash
+uv sync
+uv pip install .[cli]
+poe fix        # format and lint
+poe test       # run tests with coverage
+```
+
+______________________________________________________________________
+
+## Publishing
+
+1. Tag a release:
+
+   ```bash
+   git tag v0.1.0
+   git push --tags
+   ```
+
+2. GitHub Actions will build using *uv‑dynamic‑versioning* and publish to PyPI if
+   `PYPI_API_TOKEN` is defined in repository secrets.
+
+______________________________________________________________________
+
+## TODO

nix_base32-0.4.2/LICENSE

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

nix_base32-0.4.2/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: nix-base32
+Version: 0.4.2
+Summary: Pure Python implementation of nix variant of base32
+Author-email: "Peter A." <ink.splatters@pm.me>
+License: MIT License
+        
+        Copyright (c) 2025 Peter A.
+        
+        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
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.14
+Provides-Extra: cli
+Requires-Dist: click>=8.3.0; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# nix‑base32
+
+Pure‑Python implementation of the Nix‑specific base32 variant.
+
+______________________________________________________________________
+
+## Installation
+
+```bash
+uv tool install 'nix-base32[cli] @ git+https://github.com/ink-splatters/nix-base32'
+```
+
+______________________________________________________________________
+
+## Usage
+
+### Python
+
+```python
+from base32 import encode, decode
+
+data = b"hello"
+encoded = encode(data)
+print(encoded)           # -> NixBase32Str('nbswy3dp')
+print(decode(encoded))   # -> b'hello'
+```
+
+### CLI
+
+the CLI was inspired by BSD bintrans' `base64` util (now part of standard macOS distribution).
+
+_Examples:_
+
+```bash
+❯ echo de2fc4ce5252da49a272fb22e68c73dcfa12ef08077ac26b40ad3a40dd31376e | base32
+0vip67fl0fmd81mw4yh713pi5ynwff6fc8pvfai4knjjab7c8byy
+
+❯ echo 0vip67fl0fmd81mw4yh713pi5ynwff6fc8pvfai4knjjab7c8byy | base32 --sri
+sha256-3i/EzlJS2kmicvsi5oxz3PoS7wgHesJrQK06QN0xN24=
+
+❯ echo de2fc4ce5252da49a272fb22e68c73dcfa12ef08077ac26b40ad3a40dd31376e | base32 | base32 -d
+de2fc4ce5252da49a272fb22e68c73dcfa12ef08077ac26b40ad3a40dd31376e
+```
+
+______________________________________________________________________
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+## Contributions
+
+Contributions are welcome at the author's discretion; please open an issue first.
+See any standard open collaborative code of conduct such as
+[Contributor Covenant](https://www.contributor-covenant.org/).