These docs are for v5.0. Click to read the latest docs for v2023.

0 - Setting up the demo repository

To start, letโ€™s set up the demo repository.

Fork and clone the repository

Fork the demo repository from GitLab. It is strongly recommended that you fork the repository to your personal GitLab account.
Clone your new repository to your local machine.

Checkout a new branch

After you have cloned the repository, checkout a new branch step0

cd codecov-demo
git checkout -b step0

Install the dependencies

pip install flask and pytest-cov by running and saving down these dependencies. Note that it is recommended that this is done in a virtual environment.

pip install flask
pip install pytest-cov
pip freeze --local > api/requirements.txt

Ensure your repository has the following structure.

--> tree
.
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ README.md
โ””โ”€โ”€ api
    โ”œโ”€โ”€ __init__.py
    โ””โ”€โ”€ requirements.txt

1 directory, 4 files

Commit and merge your changes

Commit your changes by running

git add .
git commit -m 'step0: add python dependencies'
git push origin step0

Create a merge request on GitLub and merge the changes.
When opening merge requests, be sure to select your own repository as the base branch.