Simple Correios Tracking Service

A simple API to get tracking events from Correios in a JSON format

Installation

Requirements

brew install pyenv (optional)
brew install pyenv-virtualenv (optional)
brew install pipenv

STCS uses diagram lib that depends on Graphviz to render the diagram, so you need to install Graphviz to update diagrams images

brew install graphviz

Create virtual enviroment

You can use the code below to create it via pyenv:

pyenv virtualenv 3.8.0 scts

Or you can just create a virtualenv and activate:

python3 -m venv venv
. venv/bin/activate

Just make sure you are using python 3.8.

Install

make Install
make migrations
make migrate

How to run it

make run

How to use it

Access:

localhost:8000/tracking/ON769530126BR

in which, ON769530126BR is a valid tracking code from Correios

Run tests and check Coverage

make tests

Diagrams