- First of all make sure to have a 3.x python version installed
- I suggest to create a python virtual environment
- Install the library in editing mode and all the test dependencies:
python -m pip install -e .[test]
You're now 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/pythonapp.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 can be updated running the following command:
python -m robot.libdoc src/RequestsLibrary doc/RequestsLibrary.html
In this GitHub Project Board are mainly tracked the priorities and plans for the next versions.
Of course you can always reply to issues and review pull requests.
During the 17th April 2020 meetup we had the following todo list.
- Review PR: Add a post method that allows sending binary data [Nello]
- Feature: New On Session keywords [Angelo, Nicola, Roberta]
- Fix: Continuous Integration on Windows [Vincenzo, Diego]
- Tech: Integrate PyTest in CI [Luca, Andrea, Kiro]
- Experiment: Reorganize Keywords in classes
- Review PR: Support sending arrays in query string and request body
- Review PR: disable cert warnings
- Feature: Allow passing auth param to create client cert session
- Tech: Deprecate To Json keyword in favor of response.json attribute
- Tech: Moving all tests to local http server (Flask)
- Challenge: Start local http server (Flask) only once per test run instead of start/stop for each suite [Vincenzo, Diego]
https://github.com/MarketSquare/robotframework-requests/issues