requisitos básicos:

pip install -r requirements.txt

Variáveis de ambiente:

Para executar a API será necessário criar um arquivo .env na raiz do projeto, com as seguintes variáveis:

APP_ENV=local
PROJECT_NAME="Spam Predictor with FastAPI"
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_SERVER=
POSTGRES_PORT=
POSTGRES_DB=
JWT_SECRET=
LOCAL_PORT=
FIRST_SUPERUSER=
FIRST_SUPERUSER_PASSWORD=
FIRST_SUPERUSER_EMAIL=
LOG_LEVEL=
WORKERS_PER_CORE=1
MAX_WORKERS=1

Para gerar um Token JWT out JWT_SECRET, execute na linha de comando:

$ openssl rand -hex 32 

será gerado algo como b59cbee90cd294bf5e1b66fcd8a57fe8ce6999c2e0fa88304ff8c87766329937. Cole na respectiva variável.

executar a partir da linha de comando a pasta raiz do projeto:

alembic init -t async app/database/migrations

verificar no arquivo alembic.ini se está apontando para a pasta de configuracoes:

script_location = app/database/migrations e a variável:

#sqlalchemy.url =

editar o arquivo env.py:

...
# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
from app.database.base_class import Base
from app.database.session import SQLALCHEMY_DATABASE_URI

config = context.config
config.set_main_option("sqlalchemy.url", SQLALCHEMY_DATABASE_URI)


# Interpret the config file for Python logging.
# This line sets up loggers basically.
if config.config_file_name is not None:
    fileConfig(config.config_file_name)

# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
from app.models.usermodel import UserModel # noqa
from app.models.predictions import PredictionModel # noqa
target_metadata = [Base.metadata]
...

executar na linha de comando para criar as tabelas no banco de dados:

$ alembic revision --autogenerate -m "create first migrations"

$ alembic upgrade head

Para autenticar um usuário primeiramente é necessário criar um usuário utilizando o endpoint user/register. Após criá-lo utilize o endpoint /login/ fornecendo o username e a senha preenchidas no cadastro do registro.

Você irá receber um token com validade de uma hora. Esse token será sua autenticação para utilizar os serviços de verificação de Spam.

Para utilizar a API diretamente nos container, garanta que o docker-compose esteja instalado e faća:

$ docker-compose -f docker-compose.yml up -d --build 

Esse comando irá executar o arquivo docker-compose.yml, que por sua parte irá realizar primeiramente o build do banco de dados do Postgres executando o arquivo database.Dockerfile, assim que o banco de dados estiver disponível, irá executar o build da nossa aplicaćão através do arquivo Dockerfile. Quando a aplicaćão estiver de pé execute o comando

$ docker ps -a

Ambos os containers devem estar com o status UP.

para verificar os status do banco de dados execute:

$  docker-compose exec db psql --username=postgres_user --dbname=spam_ml

para listar as tabelas disponíveis use o comando \l . Para sair do psql use o comando \q.

Com o container em funcionamento é possível acessar a API diretamente pelo web browser em (https://127.0.0.1:8000)[https://127.0.0.1:8000]