Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1009 Bytes

CONTRIB.md

File metadata and controls

41 lines (27 loc) · 1009 Bytes

Python Packages

A venv is preferred to keep packages clearly identified and organized.

python -m venv .venv

# Activate
source ./.venv/Scripts/activate  # For POSIX
./.venv/Scripts/Activate.ps1     # For Windows

Whether using a venv or not, run this command to install dependencies:

pip install -r requirements.txt

Authentication

Use the create_secrets.py utility to setup your environment:

python create_secrets.py [gkey] [path/to/mlicense]

MongoDB instance: https://cloud.mongodb.com/v2/6176004f2c8d3d2789212b25

Coding guidelines

Recommended to use VS Code for easy configuration and setup (e.g. venv activated automatically).

Try to use standard Python naming conventions:

Token Naming style
variables, functions, files lower_case_with_underscores or lowercase
private variables _leading_underscore
classes CapitalizedWords

Code formatting on save is enabled by default for uniformity.