Books.Service.Transaction

Service for transactions in the Books project.

This service is intended to be the source of truth for transactions in the Books project. This includes reads and writes, though those may be handled in isolation. This is a python 3 project.

Running

To run the service,

./scripts/run.sh

This script will start a flask web server. Note that this is not suitable as a production ready server.

Using Docker Compose

This project includes a docker-compose.yml file for setting up the entire development environment. This will stand up a local CouchDB instance and connect it to the local instance of the service. Note that there are some requirements to setup the database for the first time that are not part of the compose file (documentation @TODO). To use, simple run,

docker-compose up

Database

This project uses CouchDB to store records.

Testing

To run unit tests,

./scripts/test.sh

This script will simply call the appropriate python programs to run all unit tests with pytest.

Type checking

This project is attempting to use the new python type checking. For the time being it is run using mypy. To run the type checking,

./scripts/typecheck.sh

I found this PyCon 2018 video very informative. I don't have any plans to use Pyre until there is an option to ignore missing imports.