diff --git a/README.md b/README.md index dfdb982..4267835 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ Practices](https://www.bestpractices.dev/projects/9956/badge)](https://www.bestp [![release](https://shields.io/github/release-date/btschwertfeger/kraken-infinity-grid)](https://github.com/btschwertfeger/kraken-infinity-grid/releases) [![release](https://img.shields.io/pypi/v/kraken-infinity-grid)](https://pypi.org/project/kraken-infinity-grid/) [![Documentation Status Stable](https://readthedocs.org/projects/kraken-infinity-grid/badge/?version=stable)](https://kraken-infinity-grid.readthedocs.io/en/stable) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14735203.svg)](https://doi.org/10.5281/zenodo.14735203) @@ -407,6 +408,8 @@ current state of the algorithm via Telegram Bots (see calculation is based on timestamps and a sent nonce must always be the highest nonce ever sent of that API key. Having multiple algorithms using the same keys will result in invalid nonce errors. +- Always keep an eye on https://status.kraken.com/ when encountering + connectivity problems. --- diff --git a/doc/index.rst b/doc/index.rst index d9e7785..edef2a1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -9,7 +9,7 @@ Welcome to kraken-infinity-grid's documentation! |GitHub badge| |PyVersions badge| |Downloads badge| |CI/CD badge| |Typing badge| |codecov badge| -|Release date badge| |Release version badge| +|Release date badge| |Release version badge| |DOI badge| .. toctree:: :caption: Contents: diff --git a/doc/introduction.rst b/doc/introduction.rst index 9d11c2d..cd72b73 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -7,7 +7,7 @@ Introduction |GitHub badge| |PyVersions badge| |Downloads badge| |CI/CD badge| |Typing badge| |codecov badge| -|Release date badge| |Release version badge| +|Release date badge| |Release version badge| |DOI badge| Disclaimer @@ -65,9 +65,10 @@ Troubleshooting calculation is based on timestamps and a sent nonce must always be the highest nonce ever sent of that API key. Having multiple algorithms using the same keys will result in invalid nonce errors. +- Always keep an eye on https://status.kraken.com/ when encountering + connectivity problems. - Feel free to open an issue at `kraken-infinity-grid/issues`_. - References ---------- diff --git a/doc/links.rst b/doc/links.rst index 48f839e..1102d79 100644 --- a/doc/links.rst +++ b/doc/links.rst @@ -42,3 +42,6 @@ .. |Docs stable| image:: https://readthedocs.org/projects/kraken-infinity-grid/badge/?version=stable :target: https://kraken-infinity-grid.readthedocs.io/en/stable :alt: Documentation status stable +.. |DOI badge| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.14735203.svg + :target: https://doi.org/10.5281/zenodo.14735203 + :alt: Zenodo DOI diff --git a/docker-compose.yaml b/docker-compose.yaml index 4ed6b62..d9e5e58 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -3,6 +3,18 @@ # GitHub: https://github.com/btschwertfeger # +# This Docker Compose file creates a PostgreSQL and kraken-infinity-grid +# container. +# +# In order to use this file to run the trading algorithm, a few environment +# variables must be set, see +# https://kraken-infinity-grid.readthedocs.io/en/latest/configuration.html#environment-variables +# for more information. +# +# Note: For running multiple instances of the kraken-infinity-grid in parallel, +# you can simply duplicate and configure the service, as it supports sharing the +# same database. + services: postgresql: image: postgres:13-bookworm diff --git a/pyproject.toml b/pyproject.toml index 79ef37e..4bffa30 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -91,13 +91,15 @@ asyncio_default_fixture_loop_scope = "function" [tool.coverage.run] source = ["."] - omit = ["*tests*", "_version.py"] [tool.coverage.report] exclude_lines = ["coverage: disable", "if TYPE_CHECKING:"] skip_empty = true +[tool.codespell] +check-filenames = true + # ========= T Y P I N G ======================================================== # [tool.mypy]