A simple web server that stores and manages PCB analysis project data.
Because developers are always in a rush, the project contains a Makefile to
automate most common tasks. To get an overview of the available make targets
just run make in the project directory:
~/ make
init Local dev. setup initialization
lint Source code linting
format Source code formatting according to PEP8
unit-test Run unit tests
coverage Run unit tests with code coverage
start Start the storage server
image-build Build the image
image-build-nc Build the image without caching
image-remove-force Remove the latest image (forced)
container-run Run container
container-stop Stop a running container
container-remove Remove a (running) container
container-restart Restart the container
help This help
The init target basically sets up a local development environment based on
Pipenv. You can do the same by running the
following commands in your terminal:
pipenv install --dev pylint pytest coverage autopep8 schema rope && \
pipenv install -e ./
The lint, format, unit-test and coverage targets are designed to check
and format the code.
For an interactive development experience, you can use the start target to
start a werkzeug development
server with hot reloading activated. The started server listens by default only
on the local loop-back interface on port 5000.
The recommended way to use the project storage service in a production is
to package it as a Docker image. Use the image-xxx
targets to build the Docker image. To create and start a container based on the
generated Docker image you can use the container-xxx targets.
The PCB analysis service is licensed under the GNU General Public License v3.0.
The service depends on functionality from the following third-party packages:
We like to thank the package authors for their great work and effort!