Library Rewrite

[trevorflahardy]

Library Rewrite

This PR is dedicated to the improvement and optimization of the Fortnite-api py-wrapper. It will include updates to type hinting, readability, speed, and many other items. It will allow the user to use the API both synchronously and asynchronously using the two clients given to you. Docs will also be built to assist the user in using the API.

from fortnite_api import FortniteAPI, SyncFortniteAPI

FortniteAPI().fetch_aes()
await AsyncFortniteAPI().fetch_aes()

Progress and Goals

The goal is to reshape the library to be an asynchronous library with synchronous functionality. As asynchronous Python becomes the standard for many large-scale applications that depend on this API, this step is a natural step in that direction.

• [x] Rewrite of HTTP backend.
• [ ] Update of all type hinting for every object.
• [ ] Implement library unit tests.
• [ ] Build documentation and add workflows for documentation validation.
• [ ] Create documentation for migration from the old version of the Fortnite API Python wrapper.
• [ ] Add speedup features using msgpack serialization instead of JSON for speed improvements.
• [ ] Maybe: Enable responseOptions=ignore_null to remove null fields from API communication for smaller data... requires a lot of work we'll cross that bridge when we get to it.

[Luc1412]

TODO:

• [ ] Implement tests with a real test library instead of prints
• [ ] Create an examples directory
• [ ] Add Enum for tileSize
• [ ] Add new series colors field

[trevorflahardy]

Create an examples directory

Just a heads up, this will be one of the last things I'll do.

• Refactoring of API
• Fixing tests
• Documentation
• Examples
• Preparing for Sphinx docs and building them