Orientation Project - Python

Refer to the Fellowship LMS for information!

API Documentation

You can also find the API documentation here, 23.SUM.B.1 MLH Fellowship orientation project API documentation.

Setup

You can install Poetry by running the following. This command assumes you have Python installed. Substitute python to python3 if necessary. More detailed instructions can be found here.

curl -sSL https://install.python-poetry.org | python -

Once Poetry is installed, you can install the dependencies for this project by running the following.

poetry install

Development

Here are a lists of development commands.

Activating virutal environment

After installing poetry, the virtual environment is automatically created and activated. But in case it is not activated, run the following command to activate it.

poetry shell

Adding Dependencies

You can add dependencies by running the following. Changes will be reflected in pyproject.toml and poetry.lock.

poetry add <package>

Removing Dependencies

You can remove dependencies by running the following. Changes will be reflected in pyproject.toml and poetry.lock.

poetry remove <package>

Run

python main.py

Run Tests

pytest

Run Linter

pylint *.py

Run Typechecker

pyright

Deploy

The server can be found at http://localhost:5000.

docker build -t orientation-project-python .
docker run -p 5000:5000 orientation-project-python

Contributors