development.rst

Development

Steps

1. Download the project and change the working directory to it:

   git clone git@github.com:CarlosAMolina/requests_custom
   cd requests_custom

2. Activate pipenv and install the requirements:

   python3.7 -m venv env
   source env/bin/activate
   pip install pipenv
   pipenv install pytest --dev

3. Run tox:

   tox

Update docs

1. Modify the files with the documentation to be updated.

2. Update docs configuration files:

   • docs/source/conf.py: update the release value.

3. Generate documentation:

   source env/bin/activate
   cd docs
   make clean && make html

4. Push changes.