Skip to content

chore: prep repo for going public #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StuBehan merged 1 commit into from
Apr 22, 2026
Merged

chore: prep repo for going public #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down