CONTRIBUTING.md

September 15, 2023 · View on GitHub

Setting up your environment

Create a virtual environment

python3 -m venv .venv

Activate the virtualenv

Mac/Linux

source .venv/bin/activate

Windows

venv/scripts/activate

Installing the dependencies

pip install -r requirements.txt

Configure the environment variables

Make a copy of env.sample (provided in the root of the project) called .env

cp env.sample .env

Then provide the values as follows:

  • DETA_SDK_TEST_PROJECT_KEY – Test project key (create a new Deta project for testing and grab the generated key).
  • DETA_SDK_TEST_BASE_NAME – Name of your Base.
  • DETA_SDK_TEST_DRIVE_NAME – Name of your Drive, default is fine.
  • DETA_SDK_TEST_DRIVE_HOST – Host URL, default is fine.
  • DETA_SDK_TEST_TTL_ATTRIBUTE – TTL attribute, default is fine.

Run the tests

pytest tests

🎉 Now you are ready to contribute!

How to contribute

  1. Git clone and make a feature branch
  2. Make a draft PR
  3. Make your changes to the feature branch
  4. Mark draft as ready for review