authlyx-api 3.0.0b1__tar.gz → 3.0.0b2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,127 @@
1
+ Metadata-Version: 2.4
2
+ Name: authlyx-api
3
+ Version: 3.0.0b2
4
+ Summary: Official Python SDK for AuthlyX: licensing, user sign-in, device locks, offline access and update prompts
5
+ Author: AuthlyX
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://authlyx.dev
8
+ Project-URL: Documentation, https://docs.authlyx.dev
9
+ Project-URL: Source, https://github.com/authlyx/AuthlyX-pip-library
10
+ Project-URL: Examples, https://github.com/authlyx/AuthlyX-PY-Example
11
+ Keywords: authlyx,licensing,license,authentication,hwid
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: Microsoft :: Windows
15
+ Classifier: Topic :: Software Development :: Libraries
16
+ Requires-Python: >=3.11
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: cryptography<51,>=50.0.2
20
+ Requires-Dist: aiohttp<4,>=3.14.5
21
+ Dynamic: license-file
22
+
23
+ # AuthlyX Python package
24
+
25
+ The `authlyx-api` package on PyPI. Official Python SDK for AuthlyX V3 (3.0.0 beta).
26
+
27
+ Full documentation: https://docs.authlyx.dev
28
+
29
+ ## Requirements
30
+
31
+ - Windows
32
+ - Python 3.11 or newer
33
+
34
+ ## Run the example
35
+
36
+ This repo is the package itself. For a full console example, see [AuthlyX-PY-Example](https://github.com/authlyx/AuthlyX-PY-Example). To try the package from this folder:
37
+
38
+ ```bat
39
+ pip install .
40
+ ```
41
+
42
+ You can find your app key under your app's credentials in the [dashboard](https://dash.authlyx.dev).
43
+
44
+ ## Add it to your own project
45
+
46
+ ```bat
47
+ pip install --pre authlyx-api
48
+ ```
49
+
50
+ ```python
51
+ import asyncio
52
+ from authlyx_api import AuthlyX
53
+
54
+ async def main():
55
+ app = AuthlyX("YOUR_APP_KEY", "1.0.0")
56
+ connected = await app.initialize()
57
+ print("Connected" if connected.ok else connected.message)
58
+
59
+ asyncio.run(main())
60
+ ```
61
+
62
+ Every method can be awaited. You can also pass `completed=` with a callback instead.
63
+
64
+ ## Signing in
65
+
66
+ ```python
67
+ await app.login("YOUR_USERNAME", "YOUR_PASSWORD")
68
+ await app.login("YOUR_LICENSE_KEY")
69
+ await app.deviceLogin()
70
+ ```
71
+
72
+ Device login signs in the current Windows user without a form. The device has to be approved in your app first. See [Device login](https://docs.authlyx.dev/guides/device-login).
73
+
74
+ After signing in, the account details are in `userData`:
75
+
76
+ ```python
77
+ username = app.userData["Username"]
78
+ plan = app.userData["Plan"]
79
+ expiry = app.userData["ExpiryDate"]
80
+ ```
81
+
82
+ Every method has its own page with examples under [SDK methods](https://docs.authlyx.dev/sdks/methods/login).
83
+
84
+ ## Starting up and updates
85
+
86
+ `initialize()` returns one of these codes:
87
+
88
+ | Code | Success | Meaning |
89
+ | --- | --- | --- |
90
+ | `APP_INITIALIZED` | Yes | Connected. Continue to sign-in. |
91
+ | `OFFLINE_MODE` | Yes | No internet, but this PC has saved offline access. |
92
+ | `NETWORK_...` | No | No internet and nothing saved. Offer to try again. |
93
+ | `UPDATE_REQUIRED` | No | This version is older than the one set in your dashboard. |
94
+ | `VERSION_MISMATCH` | No | This version is newer than the dashboard version and is not allowed. |
95
+
96
+ On Windows the SDK shows update messages for you: an **Update required** or **Version not supported** box when this version is refused, and an **Update available** box once after sign-in when a newer release exists. Each one shows the release notes and offers to open the download page. Set versions and download links under your app's **Updates** settings in the [dashboard](https://dash.authlyx.dev).
97
+
98
+ To show your own screen instead, turn the box off:
99
+
100
+ ```python
101
+ app = AuthlyX("YOUR_APP_KEY", "1.0.0", update_prompt=False)
102
+ ```
103
+
104
+ The failed result's `update` data then has `version`, `notes` and `url`. More in [Updates](https://docs.authlyx.dev/guides/updates) and [Allowed Versions](https://docs.authlyx.dev/guides/allowed-versions).
105
+
106
+ ## Offline access
107
+
108
+ Once someone is signed in, saving offline access stores a signed permit on that PC:
109
+
110
+ ```python
111
+ saved = await app.saveOfflineAccess()
112
+ available = await app.hasOfflineAccess()
113
+ ```
114
+
115
+ If they open your app later without internet, `initialize()` succeeds with the code `OFFLINE_MODE`, and they sign in with the same username and password or license key, and the SDK checks it against the saved permit. Each permit belongs to one app and one account, and signing out removes it. More in [Offline access](https://docs.authlyx.dev/guides/offline).
116
+
117
+ ## Errors
118
+
119
+ A failed call gives you a `code` and a `message` you can show to the user. `initialize()` returns a result even without internet. Other calls raise `AuthlyXError` for network problems and setup errors, so wrap them in `try`. All codes are listed in [Errors](https://docs.authlyx.dev/api-reference/errors).
120
+
121
+ ## Coming from 2.4
122
+
123
+ V3 is a new SDK, not a drop-in update. Apps use an app key instead of the old owner ID, app name and secret, and the method names changed. Read [Move from V2 to V3](https://docs.authlyx.dev/api-reference/migration) before you switch.
124
+
125
+ ## License
126
+
127
+ MIT. See `LICENSE`.
@@ -59,6 +59,28 @@ expiry = app.userData["ExpiryDate"]
59
59
 
60
60
  Every method has its own page with examples under [SDK methods](https://docs.authlyx.dev/sdks/methods/login).
61
61
 
62
+ ## Starting up and updates
63
+
64
+ `initialize()` returns one of these codes:
65
+
66
+ | Code | Success | Meaning |
67
+ | --- | --- | --- |
68
+ | `APP_INITIALIZED` | Yes | Connected. Continue to sign-in. |
69
+ | `OFFLINE_MODE` | Yes | No internet, but this PC has saved offline access. |
70
+ | `NETWORK_...` | No | No internet and nothing saved. Offer to try again. |
71
+ | `UPDATE_REQUIRED` | No | This version is older than the one set in your dashboard. |
72
+ | `VERSION_MISMATCH` | No | This version is newer than the dashboard version and is not allowed. |
73
+
74
+ On Windows the SDK shows update messages for you: an **Update required** or **Version not supported** box when this version is refused, and an **Update available** box once after sign-in when a newer release exists. Each one shows the release notes and offers to open the download page. Set versions and download links under your app's **Updates** settings in the [dashboard](https://dash.authlyx.dev).
75
+
76
+ To show your own screen instead, turn the box off:
77
+
78
+ ```python
79
+ app = AuthlyX("YOUR_APP_KEY", "1.0.0", update_prompt=False)
80
+ ```
81
+
82
+ The failed result's `update` data then has `version`, `notes` and `url`. More in [Updates](https://docs.authlyx.dev/guides/updates) and [Allowed Versions](https://docs.authlyx.dev/guides/allowed-versions).
83
+
62
84
  ## Offline access
63
85
 
64
86
  Once someone is signed in, saving offline access stores a signed permit on that PC:
@@ -68,11 +90,11 @@ saved = await app.saveOfflineAccess()
68
90
  available = await app.hasOfflineAccess()
69
91
  ```
70
92
 
71
- If they open your app later without internet, they sign in with the same username and password or license key, and the SDK checks it against the saved permit. Each permit belongs to one app and one account, and signing out removes it. More in [Offline access](https://docs.authlyx.dev/guides/offline).
93
+ If they open your app later without internet, `initialize()` succeeds with the code `OFFLINE_MODE`, and they sign in with the same username and password or license key, and the SDK checks it against the saved permit. Each permit belongs to one app and one account, and signing out removes it. More in [Offline access](https://docs.authlyx.dev/guides/offline).
72
94
 
73
95
  ## Errors
74
96
 
75
- A failed call gives you a `code` and a `message` you can show to the user. Network problems and some setup errors raise `AuthlyXError` instead, so wrap `initialize()` in `try` like the example does. All codes are listed in [Errors](https://docs.authlyx.dev/api-reference/errors).
97
+ A failed call gives you a `code` and a `message` you can show to the user. `initialize()` returns a result even without internet. Other calls raise `AuthlyXError` for network problems and setup errors, so wrap them in `try`. All codes are listed in [Errors](https://docs.authlyx.dev/api-reference/errors).
76
98
 
77
99
  ## Coming from 2.4
78
100
 
@@ -0,0 +1,31 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "authlyx-api"
7
+ version = "3.0.0b2"
8
+ description = "Official Python SDK for AuthlyX: licensing, user sign-in, device locks, offline access and update prompts"
9
+ readme = "README.md"
10
+ authors = [{ name = "AuthlyX" }]
11
+ keywords = ["authlyx", "licensing", "license", "authentication", "hwid"]
12
+ classifiers = [
13
+ "Development Status :: 4 - Beta",
14
+ "Programming Language :: Python :: 3",
15
+ "Operating System :: Microsoft :: Windows",
16
+ "Topic :: Software Development :: Libraries",
17
+ ]
18
+ requires-python = ">=3.11"
19
+ license = "MIT"
20
+ license-files = ["LICENSE"]
21
+ dependencies = ["cryptography>=50.0.2,<51", "aiohttp>=3.14.5,<4"]
22
+
23
+ [project.urls]
24
+ Homepage = "https://authlyx.dev"
25
+ Documentation = "https://docs.authlyx.dev"
26
+ Source = "https://github.com/authlyx/AuthlyX-pip-library"
27
+ Examples = "https://github.com/authlyx/AuthlyX-PY-Example"
28
+
29
+ [tool.setuptools.packages.find]
30
+ where = ["src"]
31
+ include = ["authlyx_api*"]
@@ -0,0 +1,127 @@
1
+ Metadata-Version: 2.4
2
+ Name: authlyx-api
3
+ Version: 3.0.0b2
4
+ Summary: Official Python SDK for AuthlyX: licensing, user sign-in, device locks, offline access and update prompts
5
+ Author: AuthlyX
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://authlyx.dev
8
+ Project-URL: Documentation, https://docs.authlyx.dev
9
+ Project-URL: Source, https://github.com/authlyx/AuthlyX-pip-library
10
+ Project-URL: Examples, https://github.com/authlyx/AuthlyX-PY-Example
11
+ Keywords: authlyx,licensing,license,authentication,hwid
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: Microsoft :: Windows
15
+ Classifier: Topic :: Software Development :: Libraries
16
+ Requires-Python: >=3.11
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: cryptography<51,>=50.0.2
20
+ Requires-Dist: aiohttp<4,>=3.14.5
21
+ Dynamic: license-file
22
+
23
+ # AuthlyX Python package
24
+
25
+ The `authlyx-api` package on PyPI. Official Python SDK for AuthlyX V3 (3.0.0 beta).
26
+
27
+ Full documentation: https://docs.authlyx.dev
28
+
29
+ ## Requirements
30
+
31
+ - Windows
32
+ - Python 3.11 or newer
33
+
34
+ ## Run the example
35
+
36
+ This repo is the package itself. For a full console example, see [AuthlyX-PY-Example](https://github.com/authlyx/AuthlyX-PY-Example). To try the package from this folder:
37
+
38
+ ```bat
39
+ pip install .
40
+ ```
41
+
42
+ You can find your app key under your app's credentials in the [dashboard](https://dash.authlyx.dev).
43
+
44
+ ## Add it to your own project
45
+
46
+ ```bat
47
+ pip install --pre authlyx-api
48
+ ```
49
+
50
+ ```python
51
+ import asyncio
52
+ from authlyx_api import AuthlyX
53
+
54
+ async def main():
55
+ app = AuthlyX("YOUR_APP_KEY", "1.0.0")
56
+ connected = await app.initialize()
57
+ print("Connected" if connected.ok else connected.message)
58
+
59
+ asyncio.run(main())
60
+ ```
61
+
62
+ Every method can be awaited. You can also pass `completed=` with a callback instead.
63
+
64
+ ## Signing in
65
+
66
+ ```python
67
+ await app.login("YOUR_USERNAME", "YOUR_PASSWORD")
68
+ await app.login("YOUR_LICENSE_KEY")
69
+ await app.deviceLogin()
70
+ ```
71
+
72
+ Device login signs in the current Windows user without a form. The device has to be approved in your app first. See [Device login](https://docs.authlyx.dev/guides/device-login).
73
+
74
+ After signing in, the account details are in `userData`:
75
+
76
+ ```python
77
+ username = app.userData["Username"]
78
+ plan = app.userData["Plan"]
79
+ expiry = app.userData["ExpiryDate"]
80
+ ```
81
+
82
+ Every method has its own page with examples under [SDK methods](https://docs.authlyx.dev/sdks/methods/login).
83
+
84
+ ## Starting up and updates
85
+
86
+ `initialize()` returns one of these codes:
87
+
88
+ | Code | Success | Meaning |
89
+ | --- | --- | --- |
90
+ | `APP_INITIALIZED` | Yes | Connected. Continue to sign-in. |
91
+ | `OFFLINE_MODE` | Yes | No internet, but this PC has saved offline access. |
92
+ | `NETWORK_...` | No | No internet and nothing saved. Offer to try again. |
93
+ | `UPDATE_REQUIRED` | No | This version is older than the one set in your dashboard. |
94
+ | `VERSION_MISMATCH` | No | This version is newer than the dashboard version and is not allowed. |
95
+
96
+ On Windows the SDK shows update messages for you: an **Update required** or **Version not supported** box when this version is refused, and an **Update available** box once after sign-in when a newer release exists. Each one shows the release notes and offers to open the download page. Set versions and download links under your app's **Updates** settings in the [dashboard](https://dash.authlyx.dev).
97
+
98
+ To show your own screen instead, turn the box off:
99
+
100
+ ```python
101
+ app = AuthlyX("YOUR_APP_KEY", "1.0.0", update_prompt=False)
102
+ ```
103
+
104
+ The failed result's `update` data then has `version`, `notes` and `url`. More in [Updates](https://docs.authlyx.dev/guides/updates) and [Allowed Versions](https://docs.authlyx.dev/guides/allowed-versions).
105
+
106
+ ## Offline access
107
+
108
+ Once someone is signed in, saving offline access stores a signed permit on that PC:
109
+
110
+ ```python
111
+ saved = await app.saveOfflineAccess()
112
+ available = await app.hasOfflineAccess()
113
+ ```
114
+
115
+ If they open your app later without internet, `initialize()` succeeds with the code `OFFLINE_MODE`, and they sign in with the same username and password or license key, and the SDK checks it against the saved permit. Each permit belongs to one app and one account, and signing out removes it. More in [Offline access](https://docs.authlyx.dev/guides/offline).
116
+
117
+ ## Errors
118
+
119
+ A failed call gives you a `code` and a `message` you can show to the user. `initialize()` returns a result even without internet. Other calls raise `AuthlyXError` for network problems and setup errors, so wrap them in `try`. All codes are listed in [Errors](https://docs.authlyx.dev/api-reference/errors).
120
+
121
+ ## Coming from 2.4
122
+
123
+ V3 is a new SDK, not a drop-in update. Apps use an app key instead of the old owner ID, app name and secret, and the method names changed. Read [Move from V2 to V3](https://docs.authlyx.dev/api-reference/migration) before you switch.
124
+
125
+ ## License
126
+
127
+ MIT. See `LICENSE`.
@@ -1,10 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: authlyx-api
3
- Version: 3.0.0b1
4
- Summary: AuthlyX v3 client
5
- License-Expression: MIT
6
- Requires-Python: >=3.11
7
- License-File: LICENSE
8
- Requires-Dist: cryptography<51,>=50.0.2
9
- Requires-Dist: aiohttp<4,>=3.14.5
10
- Dynamic: license-file
@@ -1,16 +0,0 @@
1
- [build-system]
2
- requires = ["setuptools>=77"]
3
- build-backend = "setuptools.build_meta"
4
-
5
- [project]
6
- name = "authlyx-api"
7
- version = "3.0.0b1"
8
- description = "AuthlyX v3 client"
9
- requires-python = ">=3.11"
10
- license = "MIT"
11
- license-files = ["LICENSE"]
12
- dependencies = ["cryptography>=50.0.2,<51", "aiohttp>=3.14.5,<4"]
13
-
14
- [tool.setuptools.packages.find]
15
- where = ["src"]
16
- include = ["authlyx_api*"]
@@ -1,10 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: authlyx-api
3
- Version: 3.0.0b1
4
- Summary: AuthlyX v3 client
5
- License-Expression: MIT
6
- Requires-Python: >=3.11
7
- License-File: LICENSE
8
- Requires-Dist: cryptography<51,>=50.0.2
9
- Requires-Dist: aiohttp<4,>=3.14.5
10
- Dynamic: license-file
File without changes
File without changes