supso-project 1.0.0__tar.gz

supso_project-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    name: conformance (py ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Checkout supso-project-python (this repo)
+        uses: actions/checkout@v4
+        with:
+          path: supso-project-python
+
+      # The conformance vectors live in their own repo
+      # (SupsoOrg/supso-project-spec). Check it out as a sibling so
+      # `tests/test_conformance.py` can load it via SUPSO_VECTORS_DIR.
+      - name: Checkout conformance vectors
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository_owner }}/supso-project-spec
+          path: spec
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        working-directory: supso-project-python
+        run: python -m pip install -e ".[dev]"
+
+      - name: Test (incl. conformance vectors)
+        working-directory: supso-project-python
+        env:
+          SUPSO_VECTORS_DIR: ${{ github.workspace }}/spec
+        run: pytest -q

supso_project-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release
+
+# Publishes to PyPI when you publish a GitHub Release. Uses PyPI Trusted
+# Publishing (OIDC) — no API token is stored anywhere. See RELEASING.md for the
+# one-time trusted-publisher setup on PyPI.
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # required for trusted publishing (OIDC)
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build wheel + sdist
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

supso_project-1.0.0/.gitignore

@@ -0,0 +1,35 @@
+# Byte-compiled / build artifacts
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+.env
+
+# Test / tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editor / tooling
+.idea
+.vscode
+.claude
+.gstack
+
+# macOS
+.DS_Store
+
+# Local scratch / notes
+/thoughts
+thoughts/
+
+# License certificates written during local testing
+/.supso/

supso_project-1.0.0/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Supso
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

supso_project-1.0.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: supso-project
+Version: 1.0.0
+Summary: Offline hybrid (Ed25519 + ML-DSA-44) software-license verification for project maintainers — Supported Source.
+Project-URL: Homepage, https://supso.org
+Project-URL: Repository, https://github.com/SupsoOrg/supso-project-python
+Author: Supso
+License-Expression: Apache-2.0
+License-File: LICENSE-APACHE
+Keywords: ed25519,license,licensing,ml-dsa,supported-source,verification
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: cryptography>=42
+Requires-Dist: dilithium-py>=1.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# supso (Python)
+
+Supported Source license checks for your project, from [Supported Source](https://supso.org).
+
+Use this library to enforce licensing, so you'll know who is using your project, and can
+be sure they're paying for your paid licenses. It's just one call at startup to confirm 
+the code running your software holds a valid license. The check is 100% offline, so there's
+no network, no license server to run, nothing phoning home. 
+
+```python
+import supso
+
+license = supso.require_license("acme-db")  # raises if unlicensed
+print(f"licensed to {license.organization.name}, {license.seats()} seats")
+```
+
+## Install
+
+```sh
+pip install supso-project
+```
+
+The package imports as `supso`:
+
+```python
+import supso
+```
+
+## Usage
+
+### Hard enforcement (raises when missing license)
+
+This is what we suggest you do.
+
+```python
+import supso
+supso.require_license("acme-db")
+```
+
+### Soft enforcement (does not raise errors)
+
+If you would like to handle it yourself, use `is_licensed` and then write your own logic.
+
+```python
+import supso
+
+status = supso.check_license("acme-db")  # logs a notice on grace/failure
+if supso.is_licensed(status):
+    ...  # valid or within grace — run normally
+```
+
+`status` is one of `supso.Valid`, `supso.Grace`, or `supso.Unlicensed`
+(distinguish via `status.kind` or `isinstance`).
+
+## Where licenses are found
+
+When you don't pass a token, the library looks for a `*.cert` file (each holding
+one license) in this order:
+
+1. an explicit path — the `certificate_path(...)` option or the
+   `SUPSO_LICENSE_PATH` environment variable (authoritative; no fallback);
+2. `~/.supso/license_certificates/`;
+3. `./.supso/license_certificates/`.
+
+A current license always wins. If none is current but one lapsed recently, it is
+honored as `Grace` (default window 21 days) so your app keeps running while you
+prompt the user to renew.
+
+## Errors
+
+Every failure is a `supso.SupsoError` carrying a stable `code` so you can branch
+on the reason: `malformed`, `base64`, `bad_ed25519_signature`,
+`bad_mldsa_signature`, `invalid_json`, `unsupported_schema`, `bad_timestamp`,
+`expired`, `wrong_project`, `requirement_not_met`, `no_certificate`,
+`none_valid`, `bad_trusted_key`.
+
+## Development
+
+```sh
+uv venv && source .venv/bin/activate
+uv pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache-2.0. See [`LICENSE-APACHE`](./LICENSE-APACHE).

supso_project-1.0.0/README.md

@@ -0,0 +1,87 @@
+# supso (Python)
+
+Supported Source license checks for your project, from [Supported Source](https://supso.org).
+
+Use this library to enforce licensing, so you'll know who is using your project, and can
+be sure they're paying for your paid licenses. It's just one call at startup to confirm 
+the code running your software holds a valid license. The check is 100% offline, so there's
+no network, no license server to run, nothing phoning home. 
+
+```python
+import supso
+
+license = supso.require_license("acme-db")  # raises if unlicensed
+print(f"licensed to {license.organization.name}, {license.seats()} seats")
+```
+
+## Install
+
+```sh
+pip install supso-project
+```
+
+The package imports as `supso`:
+
+```python
+import supso
+```
+
+## Usage
+
+### Hard enforcement (raises when missing license)
+
+This is what we suggest you do.
+
+```python
+import supso
+supso.require_license("acme-db")
+```
+
+### Soft enforcement (does not raise errors)
+
+If you would like to handle it yourself, use `is_licensed` and then write your own logic.
+
+```python
+import supso
+
+status = supso.check_license("acme-db")  # logs a notice on grace/failure
+if supso.is_licensed(status):
+    ...  # valid or within grace — run normally
+```
+
+`status` is one of `supso.Valid`, `supso.Grace`, or `supso.Unlicensed`
+(distinguish via `status.kind` or `isinstance`).
+
+## Where licenses are found
+
+When you don't pass a token, the library looks for a `*.cert` file (each holding
+one license) in this order:
+
+1. an explicit path — the `certificate_path(...)` option or the
+   `SUPSO_LICENSE_PATH` environment variable (authoritative; no fallback);
+2. `~/.supso/license_certificates/`;
+3. `./.supso/license_certificates/`.
+
+A current license always wins. If none is current but one lapsed recently, it is
+honored as `Grace` (default window 21 days) so your app keeps running while you
+prompt the user to renew.
+
+## Errors
+
+Every failure is a `supso.SupsoError` carrying a stable `code` so you can branch
+on the reason: `malformed`, `base64`, `bad_ed25519_signature`,
+`bad_mldsa_signature`, `invalid_json`, `unsupported_schema`, `bad_timestamp`,
+`expired`, `wrong_project`, `requirement_not_met`, `no_certificate`,
+`none_valid`, `bad_trusted_key`.
+
+## Development
+
+```sh
+uv venv && source .venv/bin/activate
+uv pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache-2.0. See [`LICENSE-APACHE`](./LICENSE-APACHE).

supso_project-1.0.0/RELEASING.md

@@ -0,0 +1,154 @@
+# Releasing `supso-project`
+
+This library is published to [PyPI](https://pypi.org/project/supso-project/) so
+maintainers can `pip install supso-project`. Three names are in play:
+
+| Thing | Value |
+|---|---|
+| GitHub repo | `SupsoOrg/supso-project-python` |
+| PyPI distribution | `supso-project` (what people `pip install`) |
+| Import package | `supso` (what they `import`) |
+
+There are two ways to publish: an **automated** GitHub Actions flow (recommended
+— no credentials stored anywhere) and a **manual** flow from your laptop. Set up
+the automated one once; fall back to manual if you ever need to.
+
+---
+
+## One-time setup (automated, recommended)
+
+PyPI [Trusted Publishing](https://docs.pypi.org/trusted-publishers/) lets GitHub
+Actions upload releases over OIDC, so there is no API token to create, store, or
+leak.
+
+1. **Create the PyPI project as a "pending" trusted publisher.** Go to
+   <https://pypi.org/manage/account/publishing/> and add a publisher with:
+   - PyPI Project Name: `supso-project`
+   - Owner: `SupsoOrg`
+   - Repository name: `supso-project-python`
+   - Workflow name: `release.yml`
+   - Environment name: `pypi`
+
+   (This works *before* the project exists on PyPI — the first successful
+   upload creates it and claims the name.)
+
+2. **Add the release workflow** at `.github/workflows/release.yml` (see
+   [Appendix](#appendix-releaseyml) below). Commit and push it.
+
+That's it. From then on, releasing is just a git tag (next section).
+
+---
+
+## Cutting a release
+
+1. **Make sure the suite is green** (against the shared spec vectors):
+
+   ```sh
+   pytest
+   ```
+
+2. **Bump the version** in `pyproject.toml`. Use
+   [semantic versioning](https://semver.org/): patch for fixes, minor for
+   backward-compatible additions, major for breaking API changes. PyPI will
+   **reject a re-upload of an existing version**, so every release needs a new
+   number.
+
+   ```toml
+   # pyproject.toml
+   version = "1.0.1"
+   ```
+
+3. **Commit and tag.** The tag must be `v` + the version.
+
+   ```sh
+   git commit -am "Release v1.0.1"
+   git tag v1.0.1
+   git push origin main --tags
+   ```
+
+4. **Publish.**
+   - **Automated:** create a GitHub Release for the tag
+     (`gh release create v1.0.1 --generate-notes`). The workflow builds and
+     uploads to PyPI automatically.
+   - **Manual:** see [Manual publishing](#manual-publishing) below.
+
+5. **Verify** the upload installs cleanly from PyPI:
+
+   ```sh
+   python -m venv /tmp/verify && /tmp/verify/bin/pip install "supso-project==1.0.1"
+   /tmp/verify/bin/python -c "import supso; print('ok')"
+   ```
+
+---
+
+## Manual publishing
+
+Use this for the very first upload if you skipped the trusted-publisher setup,
+or any time you need to publish from your machine.
+
+1. **Create a PyPI API token** at <https://pypi.org/manage/account/token/>
+   (scope it to the `supso-project` project once it exists; use an
+   account-wide token for the first upload).
+
+2. **Build** a fresh wheel + sdist:
+
+   ```sh
+   rm -rf dist
+   uv build
+   ```
+
+3. **Check** the artifacts before uploading:
+
+   ```sh
+   uvx twine check dist/*
+   ```
+
+4. **(Optional) dry-run on TestPyPI** to rehearse without touching real PyPI:
+
+   ```sh
+   uv publish --publish-url https://test.pypi.org/legacy/ --token <test-pypi-token>
+   # then: pip install --index-url https://test.pypi.org/simple/ supso-project
+   ```
+
+5. **Publish to PyPI:**
+
+   ```sh
+   uv publish --token <pypi-token>
+   # or set UV_PUBLISH_TOKEN in the environment and run `uv publish`
+   ```
+
+6. **Tag** the release if you haven't already (step 3 of *Cutting a release*).
+
+---
+
+## Appendix: `release.yml`
+
+Drop this at `.github/workflows/release.yml`. It builds on every published
+GitHub Release and uploads to PyPI via the trusted publisher configured above —
+no secrets required.
+
+```yaml
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # required for trusted publishing (OIDC)
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+```