/api

An API for the Heptagram Bot

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Heptagram API

This is an API made for the Heptagram Bot. For contributing to the project, check out the CONTRIBUTING.md file.

Features

Coming soon...

Requirements

  • Python v3.7+
  • fastapi (API framework)
  • poetry (dependency manager)
  • uvicorn (ASGI server)
  • pip (needed to install poetry)

Setting up the dev environment

  1. Install Poetry

    pip install poetry

  2. Set up the project dependencies and the pre-commit hooks

    poetry install
poetry run task precommit

  3. Set up the MongoDB instance

  4. Run the project

    poetry run task start

  5. Linting your code

    poetry run task lint

Usage