At the moment the main focus is to have a stable api that can works when run from every location. In order to solve this issue the api must be tested from many different location across the world. It's not as simple as setting up a VPN because many bookmaker have some sort of VPN detection (they have to verify the location of users so they can apply the correct country gambling regulation). You can contribute your self by run the api test suite and then report the result this issue so I can update the documentation.
Poetry is used as package manager so you have to install it on your local machine.
Then clone this Github repository with
git clone https://github.com/S1M0N38/soccerapi.gitand then go into it
cd soccerapiThen install the dependencies with
poetry installFinally activate the virtual env with
poetry shellGo into soccerapi directory (the same directory where is README.md) and run
tests with pytest.
As you can read in the
README some
bookmakers change their urls quite often, so to update the urls to test on
you should run pytest with the --urls flag. The competitions() method
run to update the urls, for some bookmakers (bet365), makes many requests to
the bookmaker API. Making too many requests could result in an IP ban from
the bookmaker, then use the --urls flag carefully.
Another way to contribute is to write a Api class for a new bookmaker. For writing such class take a look at example.py or at the already implemented Api classes ( 888sport.py, bet365.py, unibet.py, ).