Repository navigation
Rewrite the documentation and update packaging - #3
Merged
Merged
Conversation
Remove the browser playground, the verification runbooks, the smoke command (octaspace-smoke and python -m octaspace) and the console scripts. The source distribution now contains only the package source, README, CHANGELOG, LICENSE and pyproject.toml.
Python 3.10 has reached end of life. Declare support for Python 3.11-3.15, use an SPDX license expression with license-files, and raise the minimum versions of the test, lint and type-check tools.
Rewrite the README for users of the published package: installation, a runnable quick start, where to find the API token in the dashboard, error handling and an overview of the resources. Links are absolute so that they work on PyPI. Add guides for client configuration, every resource method, and errors, retries and several API hosts. Use a failover host that resolves (api.octa.computer). Add docstrings to the public classes and methods. Date 0.1.0 in the changelog by its PyPI upload and add an Unreleased section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/getting-started.md(options, environment variables, shared client, keep-alive, hooks and logging),docs/resources.md(one example per method) anddocs/errors-and-reliability.md(error classes, retries, several API hosts).https://api.octa.computer, a host that resolves;update_pricestakesbase,storageandtraffic; the quick start passes the API token explicitly.pyproject.toml; theoctaspace-smokecommand andpython -m octaspaceare removed.The changelog dates 0.1.0 by its PyPI upload and lists the unreleased changes, including the two breaking ones (Python 3.11+, removed smoke command).
Verification
ruff check,ruff format --check,mypy(strict),pytest(66 passed)uv buildandtwine check --strictpass; sdist and wheel contents checkedexamples/runs against the package with mocked HTTP