pwfauth 1.0.0__tar.gz

pwfauth-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PWF Auth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pwfauth-1.0.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: pwfauth
+Version: 1.0.0
+Summary: Official Python client for PWF Auth (pwfauth.com): license-key activation, hardware-ID binding, encrypted sessions with a server-driven kill switch, free trials, remote texts/slides, and OTA update checks.
+Project-URL: Homepage, https://pwfauth.com
+Project-URL: Documentation, https://pwfauth.com/api.php
+Project-URL: Repository, https://github.com/pwfauth/pwfauth-python
+Project-URL: Issues, https://github.com/pwfauth/pwfauth-python/issues
+Author: PWF Auth
+License: MIT License
+        
+        Copyright (c) 2026 PWF Auth
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: activation,auth,authentication,drm,hwid,license-key,licensing,pwfauth,sdk
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: cryptography>=3.4
+Description-Content-Type: text/markdown
+
+# pwfauth
+
+Official Python client for [PWF Auth](https://pwfauth.com) — license keys, hardware-ID
+binding, encrypted sessions with a server-driven kill switch, free trials, remote
+texts/slides, and OTA update checks.
+
+PWF Auth is **100% free** — every feature, unlimited, forever.
+
+```bash
+pip install pwfauth
+```
+
+Python 3.9+. One dependency (`cryptography`), because Python has no AES in its
+standard library; HTTP uses `urllib` from the stdlib rather than pulling in `requests`.
+
+## Quick start
+
+```python
+import os
+import sys
+from pwfauth import PwfClient
+
+client = PwfClient(os.environ["PWFAUTH_SECRET"])
+
+def on_session_ended(error_code, message):
+    """Ban, pause, expiry, HWID reset, revoke, maintenance, or an unreachable
+    server. Actually stop here — logging alone leaves the licence unenforceable."""
+    print(f"Session ended ({error_code}): {message}", file=sys.stderr)
+    sys.exit(1)
+
+client.on_session_ended = on_session_ended
+
+login = client.login("XXXXX-XXXXX-XXXXX-XXXXX")
+if not login.success:
+    print(login.message, file=sys.stderr)   # safe to show the user
+    sys.exit(1)
+
+client.start_heartbeat()   # keeps the session alive AND enforces the kill switch
+```
+
+`start_heartbeat()` is what turns a one-time check into a live session. Revoke the key
+in your dashboard and `on_session_ended` fires on the user's machine within seconds —
+it does not wait for the next launch.
+
+## Reading the licence
+
+```python
+lic = login.license
+if lic.is_lifetime:
+    print("Lifetime licence")
+else:
+    print(f"Expires {lic.expires_at:%Y-%m-%d} — {lic.days_remaining} day(s) left")
+```
+
+`expires_at` is `None` for lifetime keys — the server sends `expires_at: null`, and
+treating that as a date is the most common integration bug against this API. The
+`is_lifetime` flag exists so you never have to.
+
+## Feature flags
+
+```python
+if login.get_boolean("pro_export"):
+    enable_export()
+```
+
+Handles the `1` / `0` / `"true"` forms the dashboard can store.
+
+## Checking a key without using a device seat
+
+```python
+status = client.check_key(key)   # no session opened, no seat consumed
+```
+
+## Hardware ID
+
+```python
+from pwfauth import get_hardware_id
+print(get_hardware_id())
+```
+
+Derived identically to the [.NET](https://www.nuget.org/packages/PWFAuth) and
+[Node](https://www.npmjs.com/package/pwfauth) clients, so **the same machine counts as
+one device under any SDK** — switching languages does not burn a second seat against
+the licence's device limit.
+
+## Everything else
+
+| Method | What it does |
+| --- | --- |
+| `login(key)` / `logout()` | Open and close a session |
+| `check_key(key)` | Read a key's state without a session |
+| `heartbeat()` | One manual beat |
+| `start_heartbeat()` / `stop_heartbeat()` | The background loop |
+| `create_trial()` | Issue a free trial for this machine |
+| `request_hardware_reset(key, reason)` | Ask an admin to unbind a device |
+| `get_app_info()` / `get_texts()` / `get_slides()` | Remote app content |
+| `check_update(version)` | OTA update check |
+| `register_account()` / `account_login()` / `change_account_password()` | User accounts |
+| `post_envelope()` / `get_envelope()` / `post_plain()` | Raw transports |
+
+## Error codes
+
+```python
+from pwfauth import PwfErrorCodes, ends_session
+
+if ends_session(res.error_code):
+    sign_out()
+```
+
+`ends_session()` returns `False` for a code it does not recognise, on purpose: an
+unknown code is far more likely to be a new transient condition than a new way of
+being banned, and locking a paying user out on a guess is the worse failure.
+
+## Links
+
+- [Dashboard](https://pwfauth.com) · [API reference](https://pwfauth.com/api.php)
+- [.NET client](https://www.nuget.org/packages/PWFAuth) · [Node client](https://www.npmjs.com/package/pwfauth) · [VS Code extension](https://marketplace.visualstudio.com/items?itemName=PWFAuth.pwfauth)
+
+MIT

pwfauth-1.0.0/README.md

@@ -0,0 +1,119 @@
+# pwfauth
+
+Official Python client for [PWF Auth](https://pwfauth.com) — license keys, hardware-ID
+binding, encrypted sessions with a server-driven kill switch, free trials, remote
+texts/slides, and OTA update checks.
+
+PWF Auth is **100% free** — every feature, unlimited, forever.
+
+```bash
+pip install pwfauth
+```
+
+Python 3.9+. One dependency (`cryptography`), because Python has no AES in its
+standard library; HTTP uses `urllib` from the stdlib rather than pulling in `requests`.
+
+## Quick start
+
+```python
+import os
+import sys
+from pwfauth import PwfClient
+
+client = PwfClient(os.environ["PWFAUTH_SECRET"])
+
+def on_session_ended(error_code, message):
+    """Ban, pause, expiry, HWID reset, revoke, maintenance, or an unreachable
+    server. Actually stop here — logging alone leaves the licence unenforceable."""
+    print(f"Session ended ({error_code}): {message}", file=sys.stderr)
+    sys.exit(1)
+
+client.on_session_ended = on_session_ended
+
+login = client.login("XXXXX-XXXXX-XXXXX-XXXXX")
+if not login.success:
+    print(login.message, file=sys.stderr)   # safe to show the user
+    sys.exit(1)
+
+client.start_heartbeat()   # keeps the session alive AND enforces the kill switch
+```
+
+`start_heartbeat()` is what turns a one-time check into a live session. Revoke the key
+in your dashboard and `on_session_ended` fires on the user's machine within seconds —
+it does not wait for the next launch.
+
+## Reading the licence
+
+```python
+lic = login.license
+if lic.is_lifetime:
+    print("Lifetime licence")
+else:
+    print(f"Expires {lic.expires_at:%Y-%m-%d} — {lic.days_remaining} day(s) left")
+```
+
+`expires_at` is `None` for lifetime keys — the server sends `expires_at: null`, and
+treating that as a date is the most common integration bug against this API. The
+`is_lifetime` flag exists so you never have to.
+
+## Feature flags
+
+```python
+if login.get_boolean("pro_export"):
+    enable_export()
+```
+
+Handles the `1` / `0` / `"true"` forms the dashboard can store.
+
+## Checking a key without using a device seat
+
+```python
+status = client.check_key(key)   # no session opened, no seat consumed
+```
+
+## Hardware ID
+
+```python
+from pwfauth import get_hardware_id
+print(get_hardware_id())
+```
+
+Derived identically to the [.NET](https://www.nuget.org/packages/PWFAuth) and
+[Node](https://www.npmjs.com/package/pwfauth) clients, so **the same machine counts as
+one device under any SDK** — switching languages does not burn a second seat against
+the licence's device limit.
+
+## Everything else
+
+| Method | What it does |
+| --- | --- |
+| `login(key)` / `logout()` | Open and close a session |
+| `check_key(key)` | Read a key's state without a session |
+| `heartbeat()` | One manual beat |
+| `start_heartbeat()` / `stop_heartbeat()` | The background loop |
+| `create_trial()` | Issue a free trial for this machine |
+| `request_hardware_reset(key, reason)` | Ask an admin to unbind a device |
+| `get_app_info()` / `get_texts()` / `get_slides()` | Remote app content |
+| `check_update(version)` | OTA update check |
+| `register_account()` / `account_login()` / `change_account_password()` | User accounts |
+| `post_envelope()` / `get_envelope()` / `post_plain()` | Raw transports |
+
+## Error codes
+
+```python
+from pwfauth import PwfErrorCodes, ends_session
+
+if ends_session(res.error_code):
+    sign_out()
+```
+
+`ends_session()` returns `False` for a code it does not recognise, on purpose: an
+unknown code is far more likely to be a new transient condition than a new way of
+being banned, and locking a paying user out on a guess is the worse failure.
+
+## Links
+
+- [Dashboard](https://pwfauth.com) · [API reference](https://pwfauth.com/api.php)
+- [.NET client](https://www.nuget.org/packages/PWFAuth) · [Node client](https://www.npmjs.com/package/pwfauth) · [VS Code extension](https://marketplace.visualstudio.com/items?itemName=PWFAuth.pwfauth)
+
+MIT

pwfauth-1.0.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pwfauth"
+version = "1.0.0"
+description = "Official Python client for PWF Auth (pwfauth.com): license-key activation, hardware-ID binding, encrypted sessions with a server-driven kill switch, free trials, remote texts/slides, and OTA update checks."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+authors = [{ name = "PWF Auth" }]
+keywords = ["licensing", "license-key", "authentication", "auth", "drm", "activation", "hwid", "sdk", "pwfauth"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Security :: Cryptography",
+]
+
+# `cryptography` is the ONLY dependency, and it is unavoidable: Python has no AES in
+# its standard library. HTTP goes through urllib rather than `requests`, so this does
+# not drag urllib3/certifi/idna/charset-normalizer into every app that installs it.
+dependencies = ["cryptography>=3.4"]
+
+[project.urls]
+Homepage = "https://pwfauth.com"
+Documentation = "https://pwfauth.com/api.php"
+Repository = "https://github.com/pwfauth/pwfauth-python"
+Issues = "https://github.com/pwfauth/pwfauth-python/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pwfauth"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/pwfauth", "tests", "README.md", "LICENSE", "pyproject.toml"]

pwfauth-1.0.0/src/pwfauth/__init__.py

@@ -0,0 +1,49 @@
+"""Official Python client for PWF Auth (https://pwfauth.com).
+
+License-key activation, hardware-ID binding, encrypted sessions with a
+server-driven kill switch, free trials, remote texts/slides, and OTA update checks.
+
+    from pwfauth import PwfClient
+    import os, sys
+
+    client = PwfClient(os.environ["PWFAUTH_SECRET"])
+
+    def on_session_ended(error_code, message):
+        print(f"Session ended ({error_code}): {message}", file=sys.stderr)
+        sys.exit(1)
+
+    client.on_session_ended = on_session_ended
+
+    login = client.login("XXXXX-XXXXX-XXXXX-XXXXX")
+    if not login.success:
+        print(login.message, file=sys.stderr)
+        sys.exit(1)
+
+    client.start_heartbeat()   # keeps the session alive AND enforces the kill switch
+
+The hardware ID is derived identically to the .NET and Node clients, so the same
+machine counts as one device no matter which SDK an app uses.
+"""
+
+from .client import PwfClient
+from .envelope import CryptoEnvelope
+from .errors import PwfCryptoError, PwfError, PwfErrorCodes, PwfHttpError, ends_session
+from .hardware_id import get_hardware_id, reset_hardware_id_cache
+from .response import License, PwfResponse
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "PwfClient",
+    "PwfResponse",
+    "License",
+    "CryptoEnvelope",
+    "PwfError",
+    "PwfHttpError",
+    "PwfCryptoError",
+    "PwfErrorCodes",
+    "ends_session",
+    "get_hardware_id",
+    "reset_hardware_id_cache",
+    "__version__",
+]