johnsturgeon / apex-legends-api Goto Github PK

View Code? Open in Web Editor NEW

7.0 1.0 1.0 95 KB

Python wrapper for https://apexlegendsapi.com

License: MIT License

Python 100.00%

apex-legends apex-legends-api python

apex-legends-api's Introduction

apex-legends-api

Python wrapper for https://apexlegendsapi.com

Installation

You can install it from source, or pip (recommended)

Requirements

python >= 3.9

Source installation

python ./setup.py install

Pip installation

pip install apex-legends-api

Usage

Register for an API Key at Apex Legends API
Here's a quick snippet to get started
All method calls return a dictionary representing the JSON in the response.

import sys
from apex_legends_api import ApexLegendsAPI,\
    ALPlatform,\
    ALPlayer,\
    ALAction,\
    ALHTTPExceptionFromResponse
from apex_legends_api.al_base import print_description

api = ApexLegendsAPI(api_key='<api_key>')

player_name = str("PlayerName")
player_uid = str("1234567890")
platform = ALPlatform.PC
action = ALAction.GET

# Example 1:
# straight API calls
try:
    basic = api.basic_player_stats(player_name=player_name, platform=platform)
    # or query by UID
    # basic = api.basic_player_stats_by_uid(uid=player_uid, platform=platform)
    history = api.events(player_name=player_name, platform=platform, action=action)
    origin_player = api.get_player_origin(player_name=player_name, show_all_hits=True)
except ALHTTPExceptionFromResponse as exception:
    print(exception)
    sys.exit()

print(basic)
print(history)
print(origin_player)

# Example 2:
# retrieve an 'ALPlayer' object
player: ALPlayer = api.get_player(name=player_name, platform=platform)
print_description(player)

Notes

See detailed documentation at ReadTheDocs
See https://apexlegendsapi.com for complete documentation.
See CHANGELOG.md for history of changes

apex-legends-api's People

Contributors

Stargazers

Watchers

Forkers

erikbatho

apex-legends-api's Issues

Add 'battlepass' level

Update deployment to deploy to PyPi

—

Created via Raycast

Rename `ImageAssets` to `ImageAsset`

Add Events class

Write a new method that allows retrieval of an ALPlayer object with no history

Add all 'reasonable' attributes to the player class

Add docstrings for each class attribute

https://www.programiz.com/python-programming/docstrings

class Person:
    """
    A class to represent a person.

    ...

    Attributes
    ----------
    name : str
        first name of the person
    surname : str
        family name of the person
    age : int
        age of the person

    Methods
    -------
    info(additional=""):
        Prints the person's name and age.
    """

Rename `DataTrackers` to `DataTracker`

Class names should be singular

Add a 'delete_all' to the Apex Legends API that deletes all tracked users

rename `match_history` to `events`

it's all events, and not just matches

Finish the Read The Docs documentation

https://github.com/readthedocs/sphinx_rtd_theme

Now that I've gotten the documentation up there, I need to review it to make sure it all makes sense, and fix any issues (grammer, etc...)

Fix pylint errors on CondensedTea/apex-legends-api PR

#26 has some pylint errors, I'm going to clean up before landing.

Add support for `since=timestamp` when that gets implemented

https://discord.com/channels/556094211972136970/653638086164480000/825161556811055174

Modify list values that return lists of special classes to declare those list types

example data_trackers: list[Trackers]

Support new 'badges' addition to the API

https://discord.com/channels/556094211972136970/556095205875515393/831305437995466823

Add test for al_base.print_description()

need parameterized fixture for supplying each object from al_base and test which runs print_description() with object from fixture.

Aggregate 'special event' trackers with normal trackers

That way when you have one legend with specialEvent_kills = 7 and another legend with kills = 10, your total_kills should be 17

Add typing to everything that can be typed

This works better for auto completion for people who are including this library into their own code

Fix 'no newline' at end of new YAML file

Remove rank from `datatracker` when there is none

Instead of making it -1

Update README with current state of ApexLegendsAPI

Move ApexLegendsAPI class to package root

Add proper error handling for the API requests

Write a method to walk somebody through setting up their data and trackers

Add `get_legend` method on ALPlayer, and promote Legend class to ALLegend

will return a ALLegend for a given player

Add support for query parameter "limit" for match history

Was added to API on 20.03:

Create workflow to automatically push tagged release to PyPi Test Server

Make player_name a list since the API can accept multiple player names

for the basic_stats api

Write unit tests

Inspired by the 'proper' unit tests over at https://github.com/xcodinas/apex-legends

Add continuous integration for checking setup.py and make sure the package dependancies work

Add new Rank Standings added to the api

Move from sdist to 'wheel' for distribution of package

Deploy package to PyPi

Error running unit tests from CondensedTea PR

test setup failed
@pytest.fixture()
    def basic_player_stats_response():
>       with open('tests/responses/basic_player_stats_response.json') as json_file:
E       FileNotFoundError: [Errno 2] No such file or directory: 'tests/responses/basic_player_stats_response.json'

conftest.py:14: FileNotFoundError

Add API for getting a player's ID from their name via the API

—

Created via Raycast

Re-work API's to support adding / deleting / querying users by UID

Convert all list subscripts to `typing List` objects

Add method to GameEvent to return tracker for key

something like

kills_tracker = game_event.get_tracker('kills)
if kills_tracker:
    print(kills_tracker['value'])

Remove debugging code that dumps json

Delete file 'main.py' from history

Update to version 1.0.1 as part of this PR, update README and CHANGELOG

bump version to 1.0.1 (external API did not change)

After this lands, I'll do a release as well

Add project to "readthedocs"

Add the `totals` available in the `basic_player` query

Come up with a naming standard for the classes

Usually, some kind of prefix.. perhaps just Apex, or AL. ALA

Add pylint action to current 'build' workflow

Add api for getting a list of tracked players

—

Created via Raycast

Change query arguments from f-strings to request params

docs: https://requests.readthedocs.io/en/latest/api/#main-interface

my MVP for this idea is working:

payload = {'uid': uid, 'platform': 'PC', 'auth': token, 'history': 1, 'action': 'get'}
s = requests.Session()
response = s.get('https://api.mozambiquehe.re/bridge', params=payload)

@johnsturgeon What do you think?

add a method `player.refresh_data()`

so that the events on a player, and any other data can be refreshed

johnsturgeon / apex-legends-api Goto Github PK

apex-legends-api's Introduction

apex-legends-api

Installation

Requirements

Source installation

Pip installation

Usage

Notes

apex-legends-api's People

Contributors

Stargazers

Watchers

Forkers

apex-legends-api's Issues

Recommend Projects

Recommend Topics

Recommend Org