README.md

Bootstrap Academy Skills Microservice

The official skills microservice of Bootstrap Academy.

If you would like to submit a bug report or feature request, or are looking for general information about the project or the publicly available instances, please refer to the Bootstrap-Academy repository.

Development Setup

1. Install Python 3.11, Poetry and poethepoet.
2. Clone this repository and cd into it.
3. Run poe setup to install the dependencies.
4. Start a PostgreSQL database, for example using Docker or Podman:

   podman run -d --rm \
       --name postgres \
       -p 127.0.0.1:5432:5432 \
       -e POSTGRES_HOST_AUTH_METHOD=trust \
       postgres:alpine

5. Create the academy-skills database:

   podman exec postgres \
       psql -U postgres \
       -c 'create database "academy-skills"'

6. Start a Redis instance, for example using Docker or Podman:

   podman run -d --rm \
       --name redis \
       -p 127.0.0.1:6379:6379 \
       redis:alpine

7. Run poe migrate to run the database migrations.
8. Run poe api to start the microservice. You can find the automatically generated swagger documentation on http://localhost:8001/docs.

Poetry Scripts

poe setup           # setup dependencies, .env file and pre-commit hook
poe api             # start api locally
poe test            # run unit tests
poe pre-commit      # run pre-commit checks
  poe lint          # run linter
    poe format      # run auto formatter
      poe isort     # sort imports
      poe black     # reformat code
    poe ruff        # check code style
    poe mypy        # check typing
    poe flake8      # check code style
  poe coverage      # run unit tests with coverage
poe alembic         # use alembic to manage database migrations
poe migrate         # run database migrations
poe env             # show settings from .env file
poe jwt             # generate a jwt with the given payload and ttl in seconds
poe check           # check course definitions
poe sync_skills     # push local skills to backend (deprecated)

PyCharm configuration

Configure the Python interpreter:

• Open PyCharm and go to Settings ➔ Project ➔ Python Interpreter
• Open the menu Python Interpreter and click on Show All...
• Click on the plus symbol
• Click on Poetry Environment
• Select Existing environment (setup the environment first by running poe setup)
• Confirm with OK

Setup the run configuration:

• Click on Add Configuration... ➔ Add new... ➔ Python
• Change target from Script path to Module name and choose the api module
• Change the working directory to root path ➔ Edit Configurations ➔ Working directory
• In the EnvFile tab add your .env file
• Confirm with OK