jacobson

self-hosted zipcode API

The initial structure I imagined would be:

*api query/get* -> search in database -> if there is any result return;
else async call to all plugins that are configured, return and insert on database

*api mutation/post* -> manually update or insert zipcodes

call to tell the api to update some register from plugins that are configured

TODO (Needed for v0.1)

• git hooks (pre-commit)
• SqlModel
• [-] Api's support plugin-like (viacep, brazilapi...) cep aberto was added for test, need to think in a better structure for plugins and tasks
• [-] Tests, need to fix a lot of tests, need to study other ways to test
• Integration Tests
• Custom exceptions
• Add log support (see loguru)
• Docs (mkdocs)
• Alembic migrations

TODO (nice to have)

• move from docker-compose to a podman pod
• study mypyc viability

DEV

The idea is to just run this command and podman will run the entire dev environment

podman compose up -d --build

You can access the api at localhost port 8000 /graphql

http://127.0.0.1:8000/graphql