wilhelmagren / gromp Goto Github PK

Holistic Python implementation of the public Riot Games Developer API.

License: MIT License

Python 99.81% Makefile 0.19%

league-of-legends riot riot-games-api valorant legends-of-runeterra teamfight-tactics api api-wrapper python discord-bot

gromp's People

Contributors

Stargazers

Watchers

Forkers

userdoom38

gromp's Issues

No real api testing exists

Currently only some functional unit tests for the League hook exists.

We need to implement some mocked API tests.

Look into how unittest.Mock works.

Implement more API endpoints (more games)

Currently only League of Legends APIs are implement.

TODO:

Valorant
Teamfight Tactics
Legends of Runeterra

All developer APIs can be found on this page.

Endpoints missing as properties for League hook

A number of NamedEndpoints are not implemented as property for the League hook. These are:

ChampionMasterv4
Championv3
Clashv1
LeagueExpv4
Leaguev4
LolChallengesv1
LolStatusv4
Tournamentv4

Add these as properties to finalize the League implementations.

Current relase is broken, "cannot import name 'handler' from partially initialized module 'gromp'"

Python 3.10.7 (main, Nov 24 2022, 19:45:47) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import gromp
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/juice/.local/lib/python3.10/site-packages/gromp/__init__.py", line 28, in <module>
    from gromp import handler
ImportError: cannot import name 'handler' from partially initialized module 'gromp' (most likely due to a circular import) (/home/juice/.local/lib/python3.10/site-packages/gromp/__init__.py)

We have circular imports... but why?

The handler module does not depend on any imports from any other submodules of the lib.

Neither does the url submodule...

Should there be no imports in the __init__ file?

Update readme for soon-to-come version bump 0.2 → 0.3

Some aspects of the root readme are incorrect/deprecated following the latest version. Some errors:

Main information under Gromp title.
Setup, local installation is incorrect
Example usage, utils functions are renamed and general hook behaviour is changed.

Some things that should be added:

Section about retrieving the Riot Games developer API token
Status badges for pipelines/workflows
Status badges for e.g. code-style, loc, etc..

👍

Implement Issue and Pull Request auto assign before next minor release

When creating a PR or Issue a github workflow should kick in to assign one contributor as responsible for reviewing and/or resolving the PR or issue.

Look into using wow-actions/auto-assign@v1 together with a config file inside .github/

🐻‍❄️

Typing should be enforced on all functions and classes.

Statically typing the library would increase readability.

Use typing and builtins libraries to type all function arguments and return types.

No typing on variable declaration, that is too verbose.

Yay or nay?

Implement unit tests before version bump 0.2 → 0.3

Currently codecov is set up but no tests are implemented. That means we get 0% code coverage.

To implement unit tests we need to answer tree things:

Define granularity of testing.
Should the structure following the same as the main module?
How do we mock API calls during testing using unittest module?

🐃 Here's a water buffalo, thanks.

Current release is broken, "no module named 'gromp.endpoint'"

When installing through PyPI and attempting to import gromp you get the following traceback:

Python 3.10.7 (main, Nov 24 2022, 19:45:47) [GCC 12.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import gromp
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/juice/.local/lib/python3.10/site-packages/gromp/__init__.py", line 28, in <module>
    from gromp.endpoint import *
ModuleNotFoundError: No module named 'gromp.endpoint'

I suspect this has to do with how submodules are imported, relative to __init__.py files. A fix is on the way in a PR.

Otherwise, what could be the problem? Everything works locally and running unittests work...