keygen-py 0.0.1.dev3__cp312-none-win32.whl

keygen_py-0.0.1.dev3.dist-info/METADATA

@@ -0,0 +1,95 @@
+Metadata-Version: 2.3
+Name: keygen-py
+Version: 0.0.1.dev3
+License-File: LICENSE
+Summary: Unofficial Keygen SDK for Python. Integrate license activation and offline licensing. Wrapper around keygen-rs rust crate
+Author-email: Terra Quantum AG <info@terraquantum.swiss>, Cedric Kring <ck@terraquantum.swiss>, Steven Beckers <sb@terraquantum.swiss>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# Unofficial Keygen Python SDK
+
+
+The `keygen-py` package allows Python programs to license using the [keygen.sh](https://keygen.sh) service.
+This is a wrapper around the rust package [keygen-rs](https://github.com/ahonn/keygen-rs) (so a lot of kudos there) to provide python bindings. 
+
+## Installing
+
+Add this to your `pyproject.toml`:
+
+```toml
+[dependencies]
+keygen-py = "0.0.1.dev1"
+```
+
+## Config
+
+### KeygenConfig
+
+Use `KeygenConfig` to configure the SDK globally. You should set this before making any API calls.
+
+```python
+from keygen_sh import set_config, KeygenConfig
+
+set_config(KeygenConfig(
+    api_url="https://api.keygen.sh",
+    api_prefix="v1",
+    api_version="v1.7",
+    account="YOUR_KEYGEN_ACCOUNT_ID",
+    product="YOUR_KEYGEN_PRODUCT_ID",
+    license_key="A_KEYGEN_LICENSE_KEY",
+    public_key="YOUR_KEYGEN_PUBLIC_KEY"
+))
+```
+
+## Usage
+
+### Validate a License
+
+To validate a license, configure `KeygenConfig` with your Keygen account details. Then call the `validate` function with a device fingerprint
+(you can use [py-machineid](https://github.com/keygen-sh/py-machineid/tree/master) for this) or keep it empty depending on your policy:
+
+```python
+import asyncio
+from keygen_sh import validate
+
+async def amain():
+    data = await validate(["YOUR_DEVICE_FINGERPRINT"], [])
+    
+    # License
+    print(data.id, data.name, data.key, data.expiry)
+
+if __name__ == '__main__':
+    asyncio.run(amain())
+```
+
+### Offline License Key Verification
+
+To verify a signed license key offline:
+
+```python
+from keygen_sh import verify, SchemeCode
+
+data = verify(SchemeCode.Ed25519Sign, "A_KEYGEN_LICENSE_KEY")
+
+# data encoded
+print(data)
+```
+
+
+## Examples
+
+For more detailed examples, please refer to the `examples` directory in the repository.
+
+## Testing
+
+When implementing a testing strategy for your licensing integration, we recommend mocking the Keygen API responses. This is especially important for CI/CD environments to prevent unnecessary load on Keygen's servers and to stay within your account's daily request limits.
+
+## Inspired by
+- [keygen-rs](https://github.com/ahonn/keygen-rs)
+- [keygen-go](https://github.com/keygen-sh/keygen-go)
+
+## License
+
+This project is licensed under the MIT License.

keygen_py-0.0.1.dev3.dist-info/RECORD

@@ -0,0 +1,8 @@
+keygen_py-0.0.1.dev3.dist-info/METADATA,sha256=MIAE36QjN9TLFSC66cMu2SH_g9mhdTjSx54gcsNG-ww,2756
+keygen_py-0.0.1.dev3.dist-info/WHEEL,sha256=UEVASIeUpdjAl1B_6jhV8WLVdRfPuElhhLy1VDNI-c0,91
+keygen_py-0.0.1.dev3.dist-info/licenses/LICENSE,sha256=5W4k6elGLWpPjS9hZlcL_KAwnmEDKfeO3Lu-jhA3pkY,1092
+keygen_sh/__init__.py,sha256=g3y8VIMBnmnm2jCciRWMowXn-4mRr6h8qsGo-zQQh3o,119
+keygen_sh/__init__.pyi,sha256=U385Sy5ZWMFccJNrM9fyEjl1Wz9DTj07Eg92F3KXwdQ,1567
+keygen_sh/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+keygen_sh/keygen_sh.cp312-win32.pyd,sha256=sqE1borcmWVezFnwmt-CsqQHEBuXgPRq37ueHar7Qn8,3033600
+keygen_py-0.0.1.dev3.dist-info/RECORD,,

keygen_py-0.0.1.dev3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.7.4)
+Root-Is-Purelib: false
+Tag: cp312-none-win32

keygen_py-0.0.1.dev3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Terra Quantum AG
+
+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.

keygen_sh/__init__.py

@@ -0,0 +1,5 @@
+from .keygen_sh import *
+
+__doc__ = keygen_sh.__doc__
+if hasattr(keygen_sh, "__all__"):
+    __all__ = keygen_sh.__all__

keygen_sh/__init__.pyi

@@ -0,0 +1,62 @@
+from enum import Enum, auto
+
+from typing import Optional
+
+class KeygenConfig:
+    def __init__(
+        self,
+        api_url: str,
+        api_version: str,
+        api_prefix: str,
+        account: str,
+        product: str,
+        package: Optional[str] = "",
+        environment: Optional[str] = None,
+        license_key: Optional[str] = None,
+        token: Optional[str] = None,
+        public_key: Optional[str] = None,
+        platform: Optional[str] = None,
+        user_agent: Optional[str] = None,
+        max_clock_drift: Optional[int] = 5,
+    ): ...
+
+class SchemeCode(Enum):
+    Ed25519Sign = auto()
+
+class License:
+    id: str
+    scheme: SchemeCode
+    key: str
+    name: Optional[str]
+    expiry: Optional[str]
+    status: Optional[str]
+    policy: Optional[str]
+
+def verify(scheme: SchemeCode, key: str) -> str:
+    """
+    Verify an offline key.
+
+    :param scheme: the scheme code
+    :param key: the key to verify
+    :return: the data in the key
+    :raises: ValueError if the key is invalid
+    """
+    ...
+
+async def validate(fingerprints: Optional[list[str]] = None, entitlements: Optional[list[str]] = None) -> License:
+    """
+    Validate a license.
+
+    :param fingerprints: optionally, the fingerprints
+    :param entitlements: optionally, the entitlements
+    :raises: RuntimeError if the license is invalid
+    """
+    ...
+
+def set_config(config: KeygenConfig) -> None:
+    """
+    Set the global configuration.
+
+    :param config: a configuration object
+    """
+    ...