SQLAlchemyExample 0.1.0

Exploring SQLAlchemy

Exploring SQLAlchemy

This project provide a sandbox to experiment with SQLAlchemy. This idea is to build an example sequentially in steps to give new users the idea on where to start and how to progress.

Along the way some principles will be exhibited. The code should be self-explanatory.

The source code in src by itself does not do much, it basically only defines the tables and some setup code. The “examples” are in the the pytest's since we are experimenting to see howe it works and if it was successfull.

References:

• https://www.tutorialspoint.com/sqlalchemy/sqlalchemy_orm_many_to_many_relationships.htm

• https://docs.sqlalchemy.org/en/14/orm/tutorial.html#building-a-relationship

• https://cyruslab.net/2020/07/16/pythoncreate-database-if-not-exists-with-sqlalchemy/

Get Up-and-Running

1. Set the following environment variables:

2. Start Docker. The docker-rebuild.bat script will git docker up and running.

Testing

This project uses pytest to run tests and also to test docstring examples.

Install the test dependencies.

Run the tests.

$ pytest tests
=== XXX passed in SSS seconds ===

Developing

The setup and installation is for Windows. Feel free to add contribute to get it running on Linux as well.

This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.

$ pip install black flake8 pre-commit
$ pre-commit install

Releasing

Releases are published automatically when a tag is pushed to GitHub.

# Set next version number
export RELEASE = x.x.x

# Create tags
git commit --allow -empty -m "Release $RELEASE"
git tag -a $RELEASE -m "Version $RELEASE"

# Push
git push upstream --tags