Skip to content

README.md

Latest commit

 

History

History
172 lines (118 loc) · 3.35 KB

README.md

File metadata and controls

172 lines (118 loc) · 3.35 KB
Raw

EpicAuth Python SDK

Official Python SDK for EpicAuth — a modern authentication and licensing solution for applications.

PyPI version Python versions License

Installation

Install the latest version from PyPI:

pip install epicauth

Upgrade to the latest version:

pip install --upgrade epicauth

Quick Start

from epicauth import EpicAuth

EpicAuthApp = EpicAuth(
    name="MyApplication",
    ownerid="YOUR_OWNER_ID",
    version="1.0",
    hash_to_check=get_checksum(),
)

That's it. Your application can now communicate with EpicAuth.

Initialization

The EpicAuth client is initialized with your application information:

from epicauth import EpicAuth

EpicAuthApp = EpicAuth(
    name="MyApplication",
    ownerid="YOUR_OWNER_ID",
    version="1.0",
    hash_to_check="YOUR_FILE_HASH",
)

EpicAuthApp.init()

Parameters

Parameter Type Description
name str Your EpicAuth application name
ownerid str Your EpicAuth owner ID
version str Current application version
hash_to_check str Application integrity hash

Example

A complete example can be found in the official example repository:

EpicAuth Python Example

https://github.com/epicauth-org/EpicAuth-Python-Example

The example repository demonstrates how to integrate the SDK into a Python application.

Features

  • Simple Python API
  • EpicAuth authentication
  • Application initialization
  • License management
  • Application version checking
  • Update detection
  • Application integrity verification
  • Lightweight integration
  • PyPI distribution

Requirements

  • Python 3.10+
  • requests

Install the SDK and its dependencies automatically with:

pip install epicauth

Project Structure

EpicAuth-python-sdk/
├── src/
│   └── epicauth/
│       ├── __init__.py
│       └── client.py
├── examples/
│   └── main.py
├── LICENSE
├── README.md
└── pyproject.toml

Development

Clone the repository:

git clone https://github.com/epicauth-org/EpicAuth-python-sdk.git
cd EpicAuth-python-sdk

Install the package locally:

pip install -e .

Versioning

EpicAuth Python SDK follows semantic versioning:

MAJOR.MINOR.PATCH

For example:

1.0.0
1.1.0
1.1.1

See the Releases page for available versions.

PyPI

The package is available on PyPI:

https://pypi.org/project/epicauth/

Install it with:

pip install epicauth

License

EpicAuth Python SDK is licensed under the Elastic License 2.0.

See LICENSE for the complete license terms.

Links

Made for developers using EpicAuth.