From 193c5c06a0c5b7a81003c3433038beb38baf4ca1 Mon Sep 17 00:00:00 2001 From: StuBehan Date: Wed, 22 Apr 2026 23:32:59 +0100 Subject: [PATCH] chore: prep repo for going public MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - pyproject.toml + CODE_OF_CONDUCT.md: maintainer and CoC-enforcement contact is now support@stackone.com (was engineering@stackone.com). SECURITY.md intentionally stays on security@stackone.com — dedicated disclosure inbox. - README install section leads with PyPI (`pipx install stackvox` / `pip install stackvox`) now that v0.2.0 is published; git-install and editable dev install are kept as fallbacks. Dev install picks up the `[dev]` extras so contributors get the full tool chain. Co-Authored-By: Claude Opus 4.7 (1M context) --- CODE_OF_CONDUCT.md | 2 +- README.md | 15 +++++++++++---- pyproject.toml | 2 +- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4ed1ef0..d4632ce 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -10,7 +10,7 @@ This Code of Conduct applies within all project spaces, and also applies when an ## Enforcement -Concerns about conduct can be reported by emailing **engineering@stackone.com**. All reports will be reviewed and investigated promptly and fairly. Project maintainers are obligated to respect the privacy and safety of the reporter. +Concerns about conduct can be reported by emailing **support@stackone.com**. All reports will be reviewed and investigated promptly and fairly. Project maintainers are obligated to respect the privacy and safety of the reporter. Maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/README.md b/README.md index 8c608ca..6ddce75 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,26 @@ Offline TTS using [Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) via [k ## Install -Recommended — install globally with pipx so `stackvox` and `stackvox-say` end up on PATH: +From PyPI — recommended for most users: ```bash -pipx install git+https://github.com/StackOneHQ/stackvox.git +pipx install stackvox # global CLI (`stackvox` and `stackvox-say` on PATH) +# or +pip install stackvox # use as a library ``` -Upgrade later with `pipx install --force git+https://github.com/StackOneHQ/stackvox.git` (pipx's `upgrade` doesn't always detect new commits on git installs). +From git, if you want an unreleased commit: + +```bash +pipx install git+https://github.com/StackOneHQ/stackvox.git +# upgrade later with: pipx install --force git+https://github.com/StackOneHQ/stackvox.git +``` Dev install from a clone: ```bash python3 -m venv .venv && source .venv/bin/activate -pip install -e . +pip install -e ".[dev]" ``` Model + voice files auto-download to `~/.cache/stackvox/` on first use. Override with `STACKVOX_CACHE_DIR`. diff --git a/pyproject.toml b/pyproject.toml index b96d8bd..10c5259 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,7 @@ readme = "README.md" requires-python = ">=3.10" license = "Apache-2.0" license-files = ["LICENSE", "NOTICE"] -authors = [{ name = "StackOne Technologies Ltd.", email = "engineering@stackone.com" }] +authors = [{ name = "StackOne Technologies Ltd.", email = "support@stackone.com" }] keywords = ["tts", "kokoro", "onnx", "offline", "speech"] classifiers = [ "Operating System :: MacOS",