Skip to content

Commit 34bca56

Browse files
committed
chore: align PyPI distribution name and release metadata
1 parent 4748326 commit 34bca56

3 files changed

Lines changed: 10 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ AuthForge is a license key validation service. Your app sends a license key + ha
1515

1616
## Installation
1717

18-
Copy `authforge.py` into your project (single file, stdlib only). Requires Python 3.9+.
18+
Prefer **`pip install authforge-sdk`** from [PyPI](https://pypi.org/project/authforge-sdk/) (installs the `cryptography` dependency). Imports remain **`from authforge import …`**. For a vendored single-file layout, copy `authforge.py` and add `cryptography` to your environment. Requires Python 3.9+.
1919

2020
## Minimal working integration
2121

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@ Official Python SDK for [AuthForge](https://authforge.cc) — credit-based licen
44

55
Uses `cryptography` for Ed25519 verification. Works on Python 3.9+.
66

7-
## Quick Start
7+
## Installation
88

9-
Install from PyPI:
9+
The distribution on [PyPI](https://pypi.org/project/authforge-sdk/) is **`authforge-sdk`** (same idea as scoped npm names: install name ≠ import path). After installing, import the **`authforge`** module:
1010

1111
```bash
12-
pip install authforge
12+
pip install authforge-sdk
1313
```
1414

15-
Or copy `authforge.py` into your project directly, then:
15+
**Alternative:** copy `authforge.py` into your project if you need a single-file vendored layout (you must still satisfy the `cryptography` dependency yourself).
16+
17+
## Quick Start
18+
19+
After **`pip install authforge-sdk`** (or vendoring `authforge.py`), use:
1620

1721
```python
1822
from authforge import AuthForgeClient

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["setuptools>=68", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "authforge"
6+
name = "authforge-sdk"
77
version = "1.0.0"
88
description = "Official Python SDK for AuthForge — credit-based license key authentication with Ed25519-verified responses."
99
readme = "README.md"

0 commit comments

Comments
 (0)