Development guide
Setting up development environment
QREF uses Poetry ⧉ for managing dependencies.
Therefore, we recommend you use Poetry to setup your environment. However,
if you insist on not using Poetry, the more traditional way of using
editable install with pip is still avaiable.
Using editable install with Poetry
To setup your development environment install poetry (if you don't have it yet):
And then install the project and its dependencies:
Using editable install with pip
If you prefer to manage your own environment, you can install an editable version of QREF via pip:
Warning
If you are planning to add or modify the dependencies of QREF, we highly recommend you use Poetry instead of pip editable install. Without Poetry, you will need to edit dependencies manually, which is very error-prone.
Setting up docs locally
In order to set up docs locally you need to have the appropriate dependencies – they get installed when running poetry install automatically. When done, please run: