Mongodb Python Hackpack

Python

MongoDB Python Hackpack runs on Python Version 3.8 and higher. Please ensure you have Python installed.

Poetry

This project is built using Poetry, a Python package and dependency manager. Please ensure you have Poetry installed using the official installation guide. You can also install Poetry via the following command:

# Linux, MacOS, Windows (WSL)
curl -sSL https://install.python-poetry.org | python3 -

PyMongo

This project uses PyMongo, a Python distribution containing tools for working with MongoDB.

Environment Variables

The following environment variables are required and must be stored in an .env file:

MONGODB_URI=

Connection to MongoDB

The MONGODB_URI env variable is a MongoDB connection string.

Commands

Dependencies

# Install dependencies
poetry install

# Add dependency
poetry add <dependency>

# Remove dependency
poetry remove <dependency>

Running the Code Locally

poetry run app

Formatting Code via YAPF

# Rewrite code recursively with proper formatting
poetry run yapf -ir app

# Show formatting differences recursively
poetry run yapf -dr app

Linting Code via Pylint

poetry run pylint app

Build the Code

poetry build