initial impl (#1)

.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: Run tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: extractions/setup-just@v1
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          just install
+
+      - name: Run checks
+        run: |
+          just check
+
+      - name: Run tests
+        run: |
+          just test

.gitignore

@@ -3,9 +3,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
 build/
@@ -26,15 +23,6 @@ share/python-wheels/
 *.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/
@@ -51,75 +39,10 @@ coverage.xml
 .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
-
-# 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
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
 
 # 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
@@ -130,33 +53,4 @@ 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/
+.ruff_cache/

Justfile

@@ -0,0 +1,59 @@
+# To install Just, see: https://github.com/casey/just#installation
+
+# Allow for positional arguments in Just receipes.
+set positional-arguments := true
+
+# Dump the Python stack trace on crashes.
+export PYTHONFAULTHANDLER := "1"
+
+# Default recipe that runs if you type "just".
+default: format check test
+
+# Install dependencies for local development.
+install:
+    pip install poetry==1.7.1
+    cd ultravox-client && poetry install --sync
+    cd example && poetry install --sync --no-root
+
+# Format code.
+format: format-sdk format-example
+
+format-sdk: (format-python "ultravox-client")
+
+format-example: (format-python "example")
+
+format-python PATH="ultravox-client":
+    cd {{PATH}} && poetry run ruff format
+    cd {{PATH}} && poetry run ruff check --fix-only
+
+# Analyze code.
+check: check-sdk check-example
+
+check-sdk: (check-python "ultravox-client")
+
+check-example: (check-python "example")
+
+check-python PATH="ultravox-client":
+    cd {{PATH}} && poetry check
+    cd {{PATH}} && poetry run ruff format --check
+    cd {{PATH}} && poetry run ruff check
+    cd {{PATH}} && poetry run pyright .
+    cd {{PATH}} && poetry run deptry .
+
+# Run tests.
+test: test-sdk
+
+test-sdk *ARGS="--dist loadgroup -n auto .":
+    cd ultravox-client && poetry run pytest --ignore third_party {{ARGS}}
+
+test-sdk-verbose PATH=".":
+    cd ultravox-client && poetry run pytest --ignore third_party -vv --log-cli-level=INFO {{PATH}}
+
+# Format, analyze, and test one package.
+sdk: format-sdk check-sdk test-sdk
+
+example: format-example check-example # example has no tests right now
+
+# Run the Ultravox example.
+run-example *FLAGS:
+    cd example && poetry run python ultravox_example/client.py {{FLAGS}}

README.md

@@ -1,2 +1,17 @@
-# ultravox-client-sdk-python
-Python client SDK for Ultravox.
+# Ultravox client SDK for Python
+Python client SDK for [Ultravox](https://ultravox.ai).
+
+[![pypi-v](https://img.shields.io/pypi/v/ultravox-client.svg?label=ultravox-client&color=orange)](https://pypi.org/project/ultravox-client/)
+
+## Getting started
+
+```bash
+pip install ultravox-client
+```
+
+## Project structure
+
+* ultravox-client contains the client SDK code
+* example contains a working example
+
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies along with [Just](https://just.systems/) for shorthand commands.

example/README.md

@@ -0,0 +1,10 @@
+# Example Ultravox client
+This demonstrates a simple example of using the Ultravox client in Python.
+
+Run from the example directory with:
+
+```
+poetry run python ultravox_example/client.py --join-url=$JOIN_URL
+```
+
+You can get a `join_url` from the [Ultravox REST API](https://fixie-ai.github.io/ultradox/).