mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-04-19 08:55:15 +00:00

Dominique Lasserre b620250536 Streamline Dockerfile, remove unused deps

* Dockerfile: Use non-root user, buildx cache, setup for readonly
   container, remove unused apt deps.
   For now don't install pip package and keep development flask server
   as this will be replaced in the future (fastapi). Then a proper
   webserver (e.g. nginx) should be used and the pip package can be
   created and deployed just to the run-stage (with the webserver).
 * docker-compose: Set to readonly (anonymous volumes declared in
   Dockerfile should maintain all writable data).
   Mount config.py for easier development. Should be replaced by
   environment support for all config file variables.
 * Remove unused runtime dependencies: mariadb, joblib, pytest,
   pytest-cov.
 * Move pytest-cov to dev dependencies.
 * Add output_dir to config.py.
 * Fix visualization_results.pdf endpoint.
 * Update docs.

2024-10-11 08:39:14 +02:00

1.3 KiB

Raw Blame History

Contributing to EOS

Thanks for taking the time to read this!

The EOS project is in early development, therefore we encourage contribution in the following ways:

Bug Reports

Please report flaws or vulnerabilities in the GitHub Issue Tracker using the corresponding issue template.

Ideas & Features

Please first discuss the idea in a GitHub Discussion or the Akkudoktor Forum before opening an issue.

There are just too many possibilities and the project would drown in tickets otherwise.

Code Contributions

We welcome code contributions and bug fixes via Pull Requests. To make collaboration easier, we require pull requests to pass code style and unit tests.

Code Style

Our code style checks use pre-commit.

pip install -r requirements-dev.txt

To run formatting automatically before every commit:

pre-commit install

Or run them manually:

pre-commit run --all-files

Tests

Use pytest to run tests locally:

python -m pytest -vs --cov modules --cov-report term-missing tests/

1.3 KiB Raw Blame History