CONTRIBUTING.md

Contributing to the package

Development Environment

First create a virtual environment:

robotframework-library-example$ python -m venv venv

If the venv is not activated automatically, run:

robotframework-library-example$ venv\Scripts\activate

You can simply install the package in editable mode from inside the venv:

robotframework-library-example$ pip install -e .

This will also install the required packages listed in setup.cfg as install_requires.

But consider that changes to the setup files are only applied if you reinstall the package.

If you want to create the package run:

robotframework-library-example$ python setup.py sdist

This project uses tox to run different environments:

• testenv:
  • pytest
  • pylint
  • coverage
  • mypy

So in order to run the test simply install tox in your venv:

robotframework-library-example$ pip install tox

After that just run

robotframework-library-example$ tox

Look at the tox.ini file at the [testenv] section if you want to know what is executed inside the tox environment and which python versions are tested.

Documentation

For the creation of the documentation we use the tox section [testenv:doc] which can simply be run with

tox -e doc

This will create a folder doc/libdoc which contains the created keyword documentation and can be exported.

Acceptance Tests

Run

robot --loglevel DEBUG atest

The --loglevel DEBUG will show you full traceback on errors.