brazfoot_cli is a CLI application written in Python that extracts information about brazillian football competitions and save them as structured file format (json
, xml
and csv
) into the export folder.
brazfoot_cli requires Python 3.9+.
Execute the commands below to setup the application according to your platform; Linux or Windows only.
- Clone this repository:
git clone https://github.com/krauss/brazfoot_cli.git
- Change directory:
cd brazfoot_cli
- Create a virtual environment:
python -m venv venv
- Activate the virtual environment:
source venv/bin/activate
- Install brazfoot_cli dependencies:
pip install -r requirements.txt
- Run brazfoot_cli application:
python run.py
- to check the available command options:
python run.py --help
- To exit the virtual environment:
deactivate
- Clone this repository:
git clone https://github.com/krauss/brazfoot_cli.git
- Change directory:
cd brazfoot_cli
- Create a virtual environment:
python -m venv venv
- Activate the virtual environment:
.\venv\Scripts\activate
- Install brazfoot_cli dependencies:
pip install -r requirements.txt
- Run brazfoot_cli application:
python run.py
- to check the available command options:
python run.py --help
- To exit the virtual environment:
deactivate
Docker setup 🐳
To quickly try this out, download our image and run it following the steps below:
- Change directory:
cd brazfoot_cli
- Build the container
docker build -t brazfoot_cli .
- [ Linux ] Run the container specifying a volume for the resulting json file
docker run -it -v $PWD/export:/usr/src/app/export brazfoot_cli
- [ Windows ] Run the container specifying a volume for the resulting json file
docker run -it -v %USERPROFILE%\export:/usr/src/app/export brazfoot_cli