Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.22 KB

How to contribute to soccerapi

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.

Installing the development version

Pipenv is used as package manager (maybe in the future Poetry will be used) so you have to install it on your local machine.

Then clone this Github repository with

git clone https://github.com/S1M0N38/soccerapi.git

and then go into it

cd soccerapi

Then install soccerapi with

pip install -e .

and the developer dependencies with

pipenv install --dev

Running the test suite

Go into soccerapi directory (the same directory where is README.md) and run tests with pipenv run pytest