- First of all make sure to have a 3.x python version installed
- Clone the source code:
git@github.com:MarketSquare/robotframework-archivelibrary.git - I suggest to create a python virtual environment:
cd robotframework-requests/
python -m venv venv
source venv/bin/activate- Install the library in editing mode and all the test dependencies:
python -m pip install -e - Run acceptance tests with robot:
robot ./atests - Run unit tests wiht pytest:
pytest ./utests
If everything went well now you're ready to go!
Many checks and tests are automatically performed in Continuous Integration with the GitHub Actions.
Have a look at the file .github/workflows/python-app.yml to see the commands used.
The project uses flake8 for linting the source code.
PyTest is integrated for unit tests that located in utests/ folder.
Obviously for acceptance tests Robot Framework is used, files are located in atests/.
Test coverage is evaluated for unit and acceptance tests, after test execution
coverage report command shows you the statistics.
Keywords documentation (on Linux) can be updated running the following script:
doc/generate_doc.sh