Skip to main content

HTTP wrapper for the Epic/Fortnite APIs.

Project description

Code style: black

Still in early development.

PyEpic

An asynchronous, object-oriented API wrapper for the Epic/Fortnite HTTP services, written in Python.

Key Features

  • Use of the asyncio framework to handle many IO-bound tasks concurrently.
  • Automatic, configurable rate limit handling and caching.
  • Optimised for a balance of speed and memory.

Installing

Python 3.10 or higher is required. For project dependencies, see requirements.txt.

It is recommended to install the library within a virtual environment instead of the global Python installation.

# Windows
py -m pip install py-epic

# Linux/MacOS
python3 -m pip install py-epic

Basic Example

import asyncio
import pyepic


async def main():
    async with pyepic.HTTPClient() as client:
        auth_code = input(f'Enter authorization code from {client.user_auth_path} here: ')

        async with client.create_auth_session(auth_code) as auth_session:
            account = await auth_session.account()

            print(f'Logged in as: {account}')


asyncio.run(main())

Notes

  • PyEpic does not (currently) support Epic Games' XMPP services. This includes real-time in-game events such as party invites or whispers.

Disclaimers

  • The APIs that PyEpic interacts with are not officially documented, nor are they intended to be used outside the official clients.
    • The package could experience major breaking changes (or stop working!) at any moment.
    • The developer can not take responsibility for any damages that result from using the package.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_epic-0.1.2.tar.gz (44.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_epic-0.1.2-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file py_epic-0.1.2.tar.gz.

File metadata

  • Download URL: py_epic-0.1.2.tar.gz
  • Upload date:
  • Size: 44.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for py_epic-0.1.2.tar.gz
Algorithm Hash digest
SHA256 cdadce3d9d6f2cd706e610f6be924c3123b330da10b9ea9c588bac41a7f23eba
MD5 2e529f223966fbb2ad48beeb777d8e54
BLAKE2b-256 f7c0705d18047aeb009c1e03dbb74bad9b2db2fe25aa33806882f0acd7d253aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_epic-0.1.2.tar.gz:

Publisher: build.yml on delliott0000/PyEpic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_epic-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: py_epic-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for py_epic-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 273d70b9b210091176bc55aa86b2ee97f252aabb4b831fa42c18ac85ba59e173
MD5 6b5c99845935df702cf2f1c6695cf62c
BLAKE2b-256 eb49af12001b9f90c43f04d19ad2c5c10863a37224c95b01c54a9c3ce5f92b74

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_epic-0.1.2-py3-none-any.whl:

Publisher: build.yml on delliott0000/PyEpic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page