diff --git a/README.md b/README.md index 161baa5..46b2f99 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ Most other uses are easily done with any http/REST client like `requests` or `ht ## Installation -TODO INSTALL setup a KBase pypi org and publish there +``` +pip install kbase-auth-client +``` ## Usage @@ -103,7 +105,7 @@ uv run scripts/process_unasync.py * Releases * The main branch is the stable branch. Releases are made from the develop branch to the main branch. - * Update the version in `auth.py`. + * Update the version in `auth.py` and `pyproject.toml`. * Tag the version in git and github. * Create a github release. diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 1318780..48bdd47 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,3 +1,7 @@ +## 0.1.1 + +* Update README with install instructions + ## 0.1.0 * Initial release diff --git a/pyproject.toml b/pyproject.toml index a7dcde1..3491006 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] -name = "kbase-auth" -version = "0.1.0" +name = "kbase-auth-client" +version = "0.1.1" description = "Client for the KBase Authentication Service" readme = "README.md" authors = [{ name = "KBase Development Team" }] @@ -12,8 +12,8 @@ classifiers = [ "Operating System :: OS Independent", ] dependencies = [ - "cacheout==0.16.0", - "httpx==0.28.1", + "cacheout>=0.16.0", + "httpx>=0.28.1", ] [build-system] @@ -33,3 +33,11 @@ dev = [ "requests==2.32.5", "unasync==0.6.0", ] + +[project.urls] +Homepage = "https://github.com/kbase/auth2_client_python" +Repository = "https://github.com/kbase/auth2_client_python" +Issues = "https://github.com/kbase/auth2_client_python/issues" + +[tool.uv] +package = true diff --git a/src/kbase/_auth/_async/client.py b/src/kbase/_auth/_async/client.py index 429abc1..63d5b93 100644 --- a/src/kbase/_auth/_async/client.py +++ b/src/kbase/_auth/_async/client.py @@ -16,7 +16,6 @@ from kbase._auth.exceptions import InvalidTokenError, InvalidUserError from kbase._auth.models import Token, User, VALID_TOKEN_FIELDS, VALID_USER_FIELDS -# TODO PUBLISH make a pypi kbase org and publish there # TODO RELIABILITY could add retries for these methods, tenacity looks useful # should be safe since they're all read only # We might want to expand exceptions to include the request ID for debugging purposes diff --git a/src/kbase/_auth/_sync/client.py b/src/kbase/_auth/_sync/client.py index a52a538..8c27868 100644 --- a/src/kbase/_auth/_sync/client.py +++ b/src/kbase/_auth/_sync/client.py @@ -16,7 +16,6 @@ from kbase._auth.exceptions import InvalidTokenError, InvalidUserError from kbase._auth.models import Token, User, VALID_TOKEN_FIELDS, VALID_USER_FIELDS -# TODO PUBLISH make a pypi kbase org and publish there # TODO RELIABILITY could add retries for these methods, tenacity looks useful # should be safe since they're all read only # We might want to expand exceptions to include the request ID for debugging purposes diff --git a/src/kbase/auth.py b/src/kbase/auth.py index 340e23a..51ab728 100644 --- a/src/kbase/auth.py +++ b/src/kbase/auth.py @@ -15,4 +15,4 @@ ) -__version__ = "0.1.0" +__version__ = "0.1.1" diff --git a/test/test_client.py b/test/test_client.py index 70c6d25..33cf6db 100644 --- a/test/test_client.py +++ b/test/test_client.py @@ -17,7 +17,7 @@ def test_version(): - assert ver == "0.1.0" + assert ver == "0.1.1" async def _create_fail(url: str, expected: Exception, cachesize=1, timer=time.time): diff --git a/uv.lock b/uv.lock index 6d7a80a..ab7b5ba 100644 --- a/uv.lock +++ b/uv.lock @@ -296,8 +296,8 @@ wheels = [ ] [[package]] -name = "kbase-auth" -version = "0.1.0" +name = "kbase-auth-client" +version = "0.1.1" source = { editable = "." } dependencies = [ { name = "cacheout" }, @@ -317,8 +317,8 @@ dev = [ [package.metadata] requires-dist = [ - { name = "cacheout", specifier = "==0.16.0" }, - { name = "httpx", specifier = "==0.28.1" }, + { name = "cacheout", specifier = ">=0.16.0" }, + { name = "httpx", specifier = ">=0.28.1" }, ] [package.metadata.requires-dev]