facetmedia 0.1.0b1__tar.gz

facetmedia-0.1.0b1/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

facetmedia-0.1.0b1/.github/workflows/acceptance.yml

@@ -0,0 +1,42 @@
+name: Acceptance
+
+# The v0.1 success metric on a fresh runner, which is a clean Linux by
+# construction: only uv, an empty home, no GPU. The same script a person runs.
+#
+# workflow_dispatch only. GitHub offers the button once this workflow is on the
+# default branch, so the first green run happens by hand after the merge.
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  acceptance:
+    name: Clean-home acceptance
+    runs-on: ubuntu-latest
+    # The voice run is budgeted at five minutes; the rest downloads models.
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+
+      - name: Run the acceptance script
+        env:
+          # Avoids the API's anonymous limit (60 requests an hour per IP); the
+          # script passes it through and never prints it.
+          GITHUB_TOKEN: ${{ github.token }}
+        run: bash scripts/acceptance.sh --keep --root "$RUNNER_TEMP/acceptance"
+
+      - name: Upload the envelope and the run logs
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: acceptance
+          path: |
+            ${{ runner.temp }}/acceptance/kokoro.json
+            ${{ runner.temp }}/acceptance/facet/logs
+          if-no-files-found: warn

facetmedia-0.1.0b1/.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: CI
+
+on:
+  pull_request:
+  # release.yml runs CI on main before releasing.
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  python-ci:
+    uses: UniverLab/workflows/.github/workflows/python-ci.yml@main

facetmedia-0.1.0b1/.github/workflows/release.yml

@@ -0,0 +1,140 @@
+name: Release
+
+# Trunk-based release (decision 10eadef1), run by hand on main, like the lab's
+# crates on UniverLab/workflows rust-release-manual.yml:
+#
+#   ci       - this repo's CI on main (each PR was checked alone; main is where they meet)
+#   version  - refuses unless pyproject.toml carries a version with no tag yet;
+#              the version is raised beforehand by a `chore(release): <version>` PR
+#   build    - wheel and sdist
+#   publish  - PyPI in the `production` environment (owner approval, main only),
+#              Trusted Publishing (OIDC): no token is stored anywhere
+#   release  - tag + GitHub release, only after PyPI accepted the files
+#
+# PyPI does not accept a reusable workflow as a Trusted Publisher
+# (pypi/warehouse#11096), so the publish job lives here. PyPI trusts:
+# owner UniverLab, repository facetmedia, workflow release.yml, environment production.
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.repository }}
+  cancel-in-progress: false
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  version:
+    name: Check Version Bump
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      tag: ${{ steps.version.outputs.tag }}
+      prerelease: ${{ steps.version.outputs.prerelease }}
+    steps:
+      - name: Release from main only
+        if: github.ref != 'refs/heads/main'
+        run: |
+          echo "::error::Releases run from main only (this run is on ${{ github.ref }})."
+          exit 1
+
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Get version from pyproject.toml
+        id: version
+        run: |
+          VERSION=$(python3 -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+          echo "tag=v${VERSION}" >> "$GITHUB_OUTPUT"
+          # PEP 440 pre-releases (0.1.0b1, 0.2.0rc1) and dev versions are marked as pre-releases.
+          if echo "$VERSION" | grep -Eq '(a|b|rc|\.dev)[0-9]+'; then echo "prerelease=true" >> "$GITHUB_OUTPUT"; else echo "prerelease=false" >> "$GITHUB_OUTPUT"; fi
+
+      - name: Check the version was bumped
+        run: |
+          if git rev-parse "${{ steps.version.outputs.tag }}" >/dev/null 2>&1; then
+            echo "::error::${{ steps.version.outputs.tag }} is already released. Raise the version in pyproject.toml (and uv.lock) in a chore(release) PR first."
+            exit 1
+          fi
+
+  build:
+    name: Build
+    needs: [ci, version]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.sha }}
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+
+      - name: Build wheel and sdist
+        run: uv build
+
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: [version, build]
+    # Waits for the owner's approval; the environment only accepts main.
+    environment:
+      name: production
+      url: https://pypi.org/p/facetmedia
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish (trusted publishing)
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+
+  release:
+    name: Tag and GitHub Release
+    needs: [version, publish]
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.sha }}
+
+      - name: Create and push tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "${{ needs.version.outputs.tag }}" -m "Release ${{ needs.version.outputs.tag }}"
+          git push origin "${{ needs.version.outputs.tag }}"
+
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+
+      - name: Generate checksums
+        run: |
+          cd dist
+          sha256sum * > SHA256SUMS.txt
+          cat SHA256SUMS.txt
+
+      - uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3
+        with:
+          tag_name: ${{ needs.version.outputs.tag }}
+          prerelease: ${{ needs.version.outputs.prerelease }}
+          generate_release_notes: true
+          files: dist/*

facetmedia-0.1.0b1/.gitignore

@@ -0,0 +1,122 @@
+# AI coding agents (paths derived from the canopy registry)
+.agents/*
+.blackboxcli/*
+.claude/*
+.cline/*
+.clineignore
+.codebuddy/*
+.codex/*
+.commandcode/*
+.continue/*
+.copilot/*
+.cursor/*
+.cursorignore
+.cursorindexingignore
+.devin/*
+.gemini/*
+.kilo/*
+.kilocode/*
+.kiro/*
+.mcp.json
+.mimocode/*
+.opencode/*
+.qoder/*
+.qwen/*
+.utim/*
+.utim_tmp/*
+.vibe/*
+CLAUDE.local.md
+kilo.json
+kilo.jsonc
+mimocode.json
+mimocode.jsonc
+opencode.json
+opencode.jsonc
+skills-lock.json
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+!tests/fixtures/registry/lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+*.mo
+*.pot
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+instance/
+.webassets-cache
+.scrapy
+docs/_build/
+.pybuilder/
+target/
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+.pdm.toml
+__pypackages__/
+celerybeat-schedule
+celerybeat.pid
+*.sage.py
+.env
+.venv
+env/
+# facetmedia's env package is source, not a virtualenv
+!src/facetmedia/env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.spyderproject
+.spyproject
+.ropeproject
+/site
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+cython_debug/
+poetry.toml
+.ruff_cache/
+pyrightconfig.json
+
+# instruction files stay committable
+!.claude/CLAUDE.md
+!.continue/rules/
+!.cursor/rules/

facetmedia-0.1.0b1/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to facetmedia
+
+Thank you for your interest in contributing!
+
+## Development workflow
+
+```bash
+git clone https://github.com/UniverLab/facetmedia.git
+cd facetmedia
+uv sync
+uv run pytest
+```
+
+Trunk-based: branch off `main` and open the PR against `main`.
+
+## CI/CD and required secrets
+
+This project uses GitHub Actions for CI (`.github/workflows/ci.yml`).
+
+### Required repository secrets
+
+| Secret | Description | Where to get it |
+|---|---|---|
+| `PYPI_API_TOKEN` | API token to publish packages to [PyPI](https://pypi.org) | [pypi.org/manage/account/token](https://pypi.org/manage/account/token/) → API Tokens → New Token |
+
+Configure secrets at:  
+`https://github.com/UniverLab/facetmedia/settings/secrets/actions`
+
+> **Tip:** If you use [ghscaff](https://github.com/UniverLab/ghscaff), you can run `ghscaff apply` to configure missing secrets interactively, or set the env var before running:
+> ```bash
+> export PYPI_API_TOKEN=<your_token>
+> ghscaff apply
+> ```
+
+## Release process
+
+Releases are automated via the `publish.yml` workflow. To cut a release:
+
+1. Bump the version in `pyproject.toml`
+2. Commit: `chore: release vX.Y.Z`
+3. Open PR to `main` — on merge, the workflow publishes to PyPI
+
+## Acceptance
+
+v0.1 is done when its success metric is measured, not assumed: from a clean
+Linux with only `uv` installed, one command produces a voice clip that
+transcribes with a word error rate under 5 %, in under five minutes, without a
+GPU. `scripts/acceptance.sh` reproduces that condition and proves it.
+
+```bash
+bash scripts/acceptance.sh             # build the wheel, clean home, remove it
+bash scripts/acceptance.sh --keep      # keep the root to inspect assets and logs
+bash scripts/acceptance.sh --wheel dist/facetmedia-0.1.0b1-py3-none-any.whl
+bash scripts/acceptance.sh --registry-ref main
+```
+
+The script builds the wheel, points `HOME`, `FACET_HOME` and every uv cache at
+one temporary root, installs the wheel with `uv tool install`, and times
+`facet run kokoro.speak tests/acceptance/voz.toml` — including the registry's
+first-use download. It then runs the other v0.1 packages' examples (Whisper,
+FFmpeg, CAD, ASCII) from the registry snapshot, re-hashing every input and
+checking every preview, and finally checks `facet list --available` and
+`facet skill kokoro`.
+
+It downloads about 2 GB of models and packages; with every environment unpacked
+the temporary root reaches about 3.5 GiB. Run it **alone**, one heavy job at a
+time on the lab machine.
+
+Set `GITHUB_TOKEN` in the environment to stay clear of the GitHub API's
+anonymous limit (60 requests an hour per IP), which a shared runner reaches
+easily. The script passes the token through to the registry download and never
+prints it.
+
+`.github/workflows/acceptance.yml` runs the same script on a fresh
+`ubuntu-latest` runner and uploads the voice envelope and the run logs. It is
+`workflow_dispatch` only: GitHub offers the button once the workflow is on the
+default branch, so the first green run happens by hand after the merge.
+
+## Code style
+
+```bash
+uv run ruff format .
+uv run ruff check .
+uv run mypy src/
+uv run pytest
+```
+
+All four must pass before merging.

facetmedia-0.1.0b1/LICENSE

@@ -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 UniverLab
+
+   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.