initial release

Author: classabbyamp

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog for netauth-python
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+
+## [0.1.0] - 2024-08-04
+### Added
+- Generated code from protobuf definitions.
+- Types for interacting with NetAuth objects.
+- Objects and methods for interacting with NetAuth servers over gRPC.
+- API documentation.
+
+
+[Unreleased]: https://github.com/netauth/netauth-python/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/netauth/netauth-python/releases/tag/v0.1.0

README.md

@@ -1 +1,52 @@
-# Python 3 interface for NetAuth clients
+## netauth-python
+
+A [NetAuth](https://netauth.org) client library for Python.
+
+### Installation
+
+```
+pip install netauth
+```
+
+### Usage
+
+netauth-python centers around the `NetAuth` object:
+
+```py
+na = netauth.NetAuth("netauth.example.org")
+
+try:
+    resp = na.system_status()
+    print(resp)
+except netauth.error.NetAuthRpcError as e:
+    print(f"Request failed: {e}")
+
+na.close()
+```
+
+`NetAuth` can also be used as a context manager and be initialized from a NetAuth configuration file:
+
+```py
+with netauth.NetAuth.with_config(Path("/etc/netauth/config.toml")) as na:
+    try:
+        resp = na.system_status()
+        print(resp)
+    except netauth.error.NetAuthRpcError as e:
+        print(f"Request failed: {e}")
+```
+
+For interactive or dynamic applications, operations that require authentication can use a callback to retrieve the user's secret:
+
+```py
+def secret_cb() -> str:
+    return getpass(prompt="Secret: ")
+
+with netauth.NetAuth("netauth.example.org", entity="demo", secret=secret_cb) as na:
+    try:
+        na.entity_kv_add("demo", "foo", ["bar", "baz"])
+    except error.NetAuthRpcError as e:
+        print(e)
+```
+
+For more information, see the [API documentation](https://python.netauth.org).
+

netauth/__init__.py

@@ -33,7 +33,7 @@
     "error",
 ]
 
-__version__ = "0.0.1"
+__version__ = "0.1.0"
 
 
 class NetAuth:

pyproject.toml

@@ -41,6 +41,7 @@ test = [
     "pytest",
 ]
 publish = [
+    "build",
     "twine",
 ]
 
@@ -51,7 +52,7 @@ Repository = "https://github.com/netauth/netauth-python"
 Changelog = "https://github.com/netauth/netauth-python/blob/master/CHANGELOG.md"
 
 [tool.setuptools]
-packages = ["netauth"]
+packages = ["netauth", "netauth._pb", "netauth._pb.v2"]
 
 [tool.setuptools.dynamic]
 version = {attr = "netauth.__version__"}