Contributing

This page describes how to setup a local environment to contribute updates to Tellliot or DVM.

Development Environment Setup

These instructions assume that a working Python interpreter (version >=3.9 & <3.10) is already installed on the system.

Clone telliot repositories to a local working directory:

git clone https://github.com/fetchoracle/telliot-feeds.git

Change directories:

cd telliot-feeds

Create and activate a virtual environment. In this example, the virtual environment is located in a subfolder called tenv:

On Mac or Linux run

python3.9 -m venv tenv
source tenv/bin/activate

On Windows run

py3.9 -m venv tenv
tenv\Scripts\activate

Install the project using using an editable installation.

pip install -e .
pip install -r requirements.txt 

Making Contributions

Once your dev environment is set up, make desired changes, create new tests for those changes, and conform to the style & typing format of the project. To do so, in the project home directory:

Run all unit tests:

pytest

Check code typing:

tox -e typing

Check style (you may need run this step several times):

tox -e style

Once all those pass, you're ready to make a pull request to the project's main branch. For example you might want to add support for reporting a new spot price.