pytesting-utils

PyTesting Utils

PyTesting Utils is a collection of utilities for the PyTesting project.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed Python at least in version 3.6.
• You have a recent Linux or MacOS machine. The library was not tested under any other operating system. Feel free to report experiences/issues on other systems.
• For development it is necessary to have the poetry packaging and dependency management system.

Installing PyTesting Utils

PyTesting Utils can be easily installed from PyPI using the pip utility:

pip install pytesting-utils

Contributing to PyTesting Utils

To contribute to PyTesting Utils, follow these steps:

• Fork this repository.
• Setup a virtual environment for development using poetry: poetry install.
• Create a branch: git checkout -b <branch_name>.
• Make your changes and commit them git commit -m '<commit_message>'.
• Push to the original branch: git push origin <project_name>/<location>.
• Create the pull request.

Please note that we require you to meet the following criteria:

• Write unit tests for your code.
• Run linting with flake8 and pylint
• Run type checking using mypy
• Format your code according to the black code style

To ease the execution of the tools, we provide a Makefile with various targets. The easiest way to execute all checks is to run make check on a poetry shell. Push your commits only if they pass all checks! These tools are also executed in continuous integration on TravisCI and will also check you pull request. Failing a check will block your pull request from being merged!

Contributors

See the Contributors page for a list of contributors. Thanks to all contributors!

License

pytesting_utils is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

pytesting_utils is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS OF A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

Your should have received a copy of the GNU Lesser General Public License along with pytesting_utils. If not, see https://www.gnu.org/licenses/.