desafio_celero: A Python repository from marcelocmatos

Desafio Celero (Python 3 e Django Rest Framework)

Projeto desenvolvido como parte do processo seletivo da empresa Celero em junho/2021

📝 Conteúdo

Sobre
Iniciando
Como Usar a API
Usado no Projeto
Testes realizados
Autor
Árvore do Projeto

🧐 Sobre

A finalidade deste desafio é testar as habilidades e conhecimento com Python 3 e Django Rest Framework. O objetivo será criar uma API rest para servir os dados do dataset “120 years of Olympic history: athletes and results” presente no Kaggle (https://www.kaggle.com/heesoo37/120-years-of-olympic-history-athletes-and-results#athlete_events.csv)

🏁 Iniciando

Instruções para rodar o projeto.

Pré Requisitos

Python 3.9 e os tens listados no arquivo requirements.txt.

asgiref==3.3.4
atomicwrites==1.4.0
attrs==21.2.0
colorama==0.4.4
Django==3.2.4
django-filter==2.4.0
djangorestframework==3.12.4
iniconfig==1.1.1
Markdown==3.3.4
numpy==1.20.3
packaging==20.9
pandas==1.2.4
pluggy==0.13.1
py==1.10.0
pyparsing==2.4.7
pytest==6.2.4
python-dateutil==2.8.1
pytz==2021.1
six==1.16.0
sqlparse==0.4.1
toml==0.10.2

Instalando

No powershell, digitar o comando abaixo para instalar todos os pacotes usados no projeto:

pip install -r requirements.txt

🔧 Testes realizados

Como poderão realizar os testes automatizados.

Quais os principais testes realizados

Ainda não desenvolvidos

Aqui serão exibidos os testes

codificação dos testes

Os testes serão no padrão do pytest

🎈 Como Usar a API

Para acessar a API você vai na página principal localizada no endereço padrão do Django: http://127.0.0.1:8000/.
Para acessar o modelo todos os dados da API, vá na página pdrão da API: http://127.0.0.1:8000/athlete/
Para acessar dado por dado, ir na página http://127.0.0.1:8000/athlete/<id_do_atleta>. Ex:

http://127.0.0.1:8000/athlete/43578

Para fazer a atualização da base de dados atravéz de um arquivo CSV deve-se acessar a página http://127.0.0.1:8000/upload_csv/
- OBS: Para atualizar via CSV deve-se ter no arquivo as seguintes colunas:

"Name","Sex","Age","Height","Weight", "Team","NOC","Games","Year","Season","City","Sport","Event","Medal"

⛏️ Usado no Projeto

Python - Language
Django - Web Framework
Django REST Framework - REST API Framework
SQLite - Database

✍️ Autor

Marcelo Cabral de Matos (@marcelocmatos) - Desenvolvedor Python Júnior

🌳 Árvore do Projeto

Desafio_Celero
├─ .gitignore
├─ athlete_events
│  ├─ admin.py
│  ├─ api
│  │  ├─ serializers.py
│  │  └─ viewsets.py
│  ├─ apps.py
│  ├─ migrations
│  │  ├─ 0001_initial.py
│  │  ├─ 0002_rename_athletesevents_athletes.py
│  │  ├─ 0003_auto_20210608_2245.py
│  │  ├─ 0004_rename_athletes_athlete.py
│  │  ├─ 0005_auto_20210609_2235.py
│  │  ├─ 0006_auto_20210609_2344.py
│  │  ├─ 0007_auto_20210609_2346.py
│  │  ├─ 0008_alter_athlete_id.py
│  │  ├─ 0009_alter_athlete_id.py
│  │  ├─ 0010_alter_athlete_id.py
│  │  ├─ 0011_alter_athlete_event.py
│  │  ├─ 0012_alter_athlete_event.py
│  │  └─ __init__.py
│  ├─ models.py
│  ├─ tests.py
│  ├─ urls.py
│  ├─ views.py
│  └─ __init__.py
├─ athlete_events.csv
├─ db.sqlite3
├─ desafio_celero
│  ├─ asgi.py
│  ├─ settings.py
│  ├─ urls.py
│  ├─ wsgi.py
│  └─ __init__.py
├─ manage.py
├─ README.md
├─ requirements.txt
├─ static
│  └─ css
│     ├─ reset.css
│     └─ style.css
└─ templates
   ├─ base.html
   └─ data_upload.html

marcelocmatos/desafio_celero