Spacepy

Projeto desenvolvido e mantido por KingPack.

Back-end Challenge 2021 - Space Flight News

Este é um desafio de programação back-end que consiste na replicação da API Space Flight News.

Tecnologias

• Poetry
• Git
• Python 3
• IPython
• Flask
• Gunicorn
• Postgres
• Heroku
• Docker
• Portainer
• Flasgger
• SQLAlchemy
• Marshmallow
• Schedule

Requisitos

1º Poetry

Para a instalação do Poetry

2º Python 3

Você deve instalar a versão 3.9.10 ou superior do Python.

3º Git

Documentação para instalação do Git.

4º Banco de dados

Tenha os dados para se conectar no banco de dados.

Após fazer o git clone do repositório, você deve criar um arquivo chamado config.py e colocar as configurações do banco de dados.

Instalação

Agora, vamos para a instalação do projeto.

Mas antes devemos verificar se temos os requisitos necessários para instalar e rodar o nosso projeto.

Poetry

Verifique se a sua versão do Poetry está igual ou superior a 1.1.12.

poetry --version

# O retorno deve ser

Poetry version 1.1.12

Python

Não podemos esquecer de averiguar a versão do Python que estamos utilizando.

python3 --version

# O retorno deve ser igual ou superior

Python 3.9.10

Git

Para verificar a versão do Git.

git --version

# retorno
 
git version 2.32.0

Entre no diretório onde vamos fazer o clone do nosso projeto.

# Veja se o diretório está correto

pwd

# E nesse diretório que vamos colocar nosso projeto

/home/hendrek/Documents/GitHub/KingPack

Agora vamos fazer o clone do projeto.

# Fazendo o clone do projeto

git clone https://github.com/KingPack/spacepy.git

# Liste o diretório para ver e entrar no projeto

ls | grep spacepy

# retorno 

spacepy

# Entre no repositorio

cd spacepy/

\o/ Oba !!! Nosso projeto está aqui.

49 % já feito

Se você chegou ate aqui sem erros, então já devemos estar preparados para inicializar o ambiente virtual do Poetry.

# comando para entrar no ambiente do poetry
poetry shell

# retorno
Creating virtualenv spacepy-oQYf1C9p-py3.9 in /home/hendrek/.cache/pypoetry/virtualenvs
Spawning shell within /home/hendrek/.cache/pypoetry/virtualenvs/spacepy-oQYf1C9p-py3.9
➜  spacepy git:(main) . /home/hendrek/.cache/pypoetry/virtualenvs/spacepy-oQYf1C9p-py3.9/bin/activate

Apos inicializar o ambiente virtual, vamos instalar e atualizar as dependências do projeto.

poetry update
 
# Retorno 

Updating dependencies
Resolving dependencies... (5.4s)

Pode demorar um pouco para instalar todas as dependências. Então vamos esperar um pouco.

Criando nossos arquivos config.py

Observação: Por conter dados sigilosos, esses arquivos sempre devem estar no .gitignore.

No diretório /spacepy/spacepy/ e spacepy/scripts/ vamos criar um arquivo chamado de ‘config.py’ e adicionar os dados do nosso banco de dados no arquivo.

# Criando o arquivo config.py
touch config.py

# Entrando no arquivo 
nano config.py

Lembra dos dados do seu banco de dados? É aqui aonde iremos adicioná-los. Com o editor aberto, insira os dados do banco e salve-os.

DB_HOST = 'localhost'
DB_PORT = 'porta'
DB_USER = 'usuario'
DB_PASS = 'senha'
DB_DATA = 'postgres'

SQLALCHEMY_DATABASE_URL = f'postgresql://{DB_USER}:{DB_PASS}@{DB_HOST}:{DB_PORT}/{DB_DATA}'

Agora vamos verificar se os dados persistiram no arquivo.

cat config.py

# Retorno
DB_HOST = 'localhost'
DB_PORT = 'porta'
DB_USER = 'usuario'
DB_PASS = 'root'
DB_DATA = 'postgres'

SQLALCHEMY_DATABASE_URL = f'postgresql://{DB_USER}:{DB_PASS}@{DB_HOST}:{DB_PORT}/{DB_DATA}'

Se tudo deu certo então agora temos nosso banco de dados salvo e configurado.

Populando nosso banco de dados

Com o nosso banco de dados configurado, está na hora de inserir alguns dados nele, certo?

Então vamos utilizar o script cycle_db.py.

Observação: Na primeira execução do código e normal que demore algumas horas ate que todos os artigos sejam inseridos no banco de dados, portanto, para evitar problemas futuros, aguarde até que o programa complete o seu primeiro ciclo.

# Iniciando o ciclo do banco de dados
python3 cycle_db.py

# O script vai pedir um horário para agendar as tarefas.

Qual horario de inicio?  exemplo: 10:00 (HH:MM) : 09:00

# Coloque como no exemplo para funcionar

Quando a adição de todos os artigos terminarem, poderemos ver o resultado no bando de dados.

Configuração do Flask

Agora vamos configurar a nossa aplicação Flask.

Devemos exportar as variáveis de ambiente no diretório raiz do projeto.

Verifique se estamos no diretório correto
pwd

# Retorno
/home/hendrek/Documents/Projects/spacepy

Agora vamos exportar nossas variáveis de ambiente para o Flask.

# Exportando o caminho do arquivo main.py para o FLASK_APP
export FLASK_APP=spacepy/main.py

# Exportando o tipo de ambiente que estamos trabalhando
export FLASK_ENV=development

Inicialização localhost

Depois que inicializamos o banco de dados e configuramos nossas variáveis de ambiente virtual, já estamos preparados para iniciar a nossa aplicação em desenvolvimento local.

# Use o comando para inicializar a aplicação

flask run

# retorno

 * Serving Flask app 'spacepy/main.py' (lazy loading)
 * Environment: development
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Se tudo ocorreu perfeitamente, já conseguiremos acessar a nossa aplicação.

Entre no link : http://127.0.0.1:5000/

Ebaaaaaa \o/ estamos no ar !!!

Veja a documentação do projeto.

Continue no README.md das rotas do spacepy.

Info

This is a challenge by Coodesh