maferelo/automata-backend

Automata

Personal scripts for automation of everyday tasks using best practices with reference notes.

Prerequisites

Clone repository

git clone https://github.com/maferelo/automata.git
cd automata

For Mac

• Docker
• Homebrew

bash scripts/prestart-mac.sh

Development

We use remote containers.

1. Press F1 to open the Command Palette.
2. Type reopen in container.
3. Select Remote Containers: Reopen in Container from the list of available options.

Inside the container run:

poetry run app

Check the endpoint

curl --location --request GET 'http://localhost:8000/'

Linting

pre-commit run --all-files

Dependencies

Use the package manager poetry to install requirements

poetry add darglint --group dev

Database migrations

Using Alembic

Change models and commit

alembic revision --autogenerate -m "<message>"
alembic upgrade head

Tests

nox --session tests -- tests/test_console.py

End to end testing

nox -s tests -- -m e2e

Deployments

Using Heroku Create staging and production apps

heroku apps create automata-backend
heroku stack:set -a automata-backend heroku-20
heroku buildpacks:add -a automata-backend \
  https://github.com/moneymeets/python-poetry-buildpack.git
heroku buildpacks:add -a automata-backend heroku/python
heroku config:set POETRY_VERSION=1.3.1

heroku login
git push heroku main
heroku open
heroku logs --tail

References

• Project homepage
• Repository
• Issue tracker
  • In case of sensitive bugs like security vulnerabilities, please contact [email protected] directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!
• Related projects
  • Your other project
  • Someone else's project
  • Awesome README