diff --git a/README.md b/README.md index c81c2b9..b9505a3 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,10 @@ You can have a local uv or docker-interpeter based setup. The repository is also configured to seamlessly working within a GitHub Codespace. See the instructions for the various setup scenarios below. -Independently of how the setup was done, the virtual environment can be activated with -`source .venv/bin/activate` (after creating it with uv) and the various tasks like formatting, testing, and documentation building +Independently of how the setup was done, the virtual environment can be +created with `uv venv` and +activated with +`source .venv/bin/activate` and the various tasks like formatting, testing, and documentation building can be executed using `poe`. For example, `poe format` will format the code, including the notebooks. Just run `poe` to see the available commands. @@ -49,5 +51,6 @@ The fastest way to get started is to use a GitHub Codespace. Just click on the button in the repository's main page. ## Contributing + Please open new issues for bugs, feature requests and extensions. See more details about the structure and workflow in the [contributing page](docs/04_contributing/04_contributing.rst). diff --git a/pyproject.toml b/pyproject.toml index 3f38ef5..24c93af 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,7 +35,8 @@ dev = [ "docutils>=0.20.1", "jinja2", "jupyter>=1.0.0", - "jupyter-book>=1.0.0", + # In version 1.0.4 we get a NoneType error related to some config conversion (yml_analytics is None and should be a list) + "jupyter-book==1.0.0", "mypy>=1.4.1", "nbqa>=1.7.1", "nbstripout>=0.6.1", diff --git a/uv.lock b/uv.lock index 4bd589b..6303454 100644 --- a/uv.lock +++ b/uv.lock @@ -442,11 +442,11 @@ wheels = [ [[package]] name = "docutils" -version = "0.21.2" +version = "0.20.1" source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/ae/ed/aefcc8cd0ba62a0560c3c18c33925362d46c6075480bfa4df87b28e169a9/docutils-0.21.2.tar.gz", hash = "sha256:3a6b18732edf182daa3cd12775bbb338cf5691468f91eeeb109deff6ebfa986f", size = 2204444 } +sdist = { url = "https://files.pythonhosted.org/packages/1f/53/a5da4f2c5739cf66290fac1431ee52aff6851c7c8ffd8264f13affd7bcdd/docutils-0.20.1.tar.gz", hash = "sha256:f08a4e276c3a1583a86dce3e34aba3fe04d02bba2dd51ed16106244e8a923e3b", size = 2058365 } wheels = [ - { url = "https://files.pythonhosted.org/packages/8f/d7/9322c609343d929e75e7e5e6255e614fcc67572cfd083959cdef3b7aad79/docutils-0.21.2-py3-none-any.whl", hash = "sha256:dafca5b9e384f0e419294eb4d2ff9fa826435bf15f15b7bd45723e8ad76811b2", size = 587408 }, + { url = "https://files.pythonhosted.org/packages/26/87/f238c0670b94533ac0353a4e2a1a771a0cc73277b88bff23d3ae35a256c1/docutils-0.20.1-py3-none-any.whl", hash = "sha256:96f387a2c5562db4476f09f13bbab2192e764cac08ebbf3a34a95d9b1e4a59d6", size = 572666 }, ] [[package]] @@ -799,7 +799,7 @@ wheels = [ [[package]] name = "jupyter-book" -version = "1.0.4.post1" +version = "1.0.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "click" }, @@ -821,9 +821,9 @@ dependencies = [ { name = "sphinx-togglebutton" }, { name = "sphinxcontrib-bibtex" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/cf/ee/5d10ce5b161764ad44219853f386e98b535cb3879bcb0d7376961a1e3897/jupyter_book-1.0.4.post1.tar.gz", hash = "sha256:2fe92c49ff74840edc0a86bb034eafdd0f645fca6e48266be367ce4d808b9601", size = 67412 } +sdist = { url = "https://files.pythonhosted.org/packages/d0/3a/bc9fd26be1672f167d2efddbf4fef82b2d52c9641786f392a84314960d6a/jupyter_book-1.0.0.tar.gz", hash = "sha256:539c5d0493546200d9de27bd4b5f77eaea03115f8937f825d4ff82b3801a987e", size = 63540 } wheels = [ - { url = "https://files.pythonhosted.org/packages/37/86/d45756beaeb4b9b06125599b429451f8640b5db6f019d606f33c85743fd4/jupyter_book-1.0.4.post1-py3-none-any.whl", hash = "sha256:3a27a6b2581f1894ffe8f347d1a3432f06fc616997547919c42cd41c54db625d", size = 45005 }, + { url = "https://files.pythonhosted.org/packages/cf/0f/7ee90f91e1a4f2e72376ad481d5f97b877b9fee4a5bf1a71deaf08a10c77/jupyter_book-1.0.0-py3-none-any.whl", hash = "sha256:18238f1e7e1d425731e60ab509a7da878dd6db88b7d77bcfab4690361b72e1be", size = 43723 }, ] [[package]] @@ -1200,7 +1200,7 @@ wheels = [ [[package]] name = "myst-parser" -version = "3.0.1" +version = "2.0.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "docutils" }, @@ -1210,9 +1210,9 @@ dependencies = [ { name = "pyyaml" }, { name = "sphinx" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/49/64/e2f13dac02f599980798c01156393b781aec983b52a6e4057ee58f07c43a/myst_parser-3.0.1.tar.gz", hash = "sha256:88f0cb406cb363b077d176b51c476f62d60604d68a8dcdf4832e080441301a87", size = 92392 } +sdist = { url = "https://files.pythonhosted.org/packages/e8/c1/48ea47b78ade0bb0281f34c9e343e3ea0c681fbc81464dbfd134e983954f/myst_parser-2.0.0.tar.gz", hash = "sha256:ea929a67a6a0b1683cdbe19b8d2e724cd7643f8aa3e7bb18dd65beac3483bead", size = 85800 } wheels = [ - { url = "https://files.pythonhosted.org/packages/e2/de/21aa8394f16add8f7427f0a1326ccd2b3a2a8a3245c9252bc5ac034c6155/myst_parser-3.0.1-py3-none-any.whl", hash = "sha256:6457aaa33a5d474aca678b8ead9b3dc298e89c68e67012e73146ea6fd54babf1", size = 83163 }, + { url = "https://files.pythonhosted.org/packages/1d/f6/6d61a023d758f488e36638076e8a4ec4447a2cdf86938cf6c60cf1c860e6/myst_parser-2.0.0-py3-none-any.whl", hash = "sha256:7c36344ae39c8e740dad7fdabf5aa6fc4897a813083c6cc9990044eb93656b14", size = 77158 }, ] [[package]] @@ -1987,7 +1987,7 @@ requires-dist = [ { name = "docutils", marker = "extra == 'dev'", specifier = ">=0.20.1" }, { name = "jinja2", marker = "extra == 'dev'" }, { name = "jupyter", marker = "extra == 'dev'", specifier = ">=1.0.0" }, - { name = "jupyter-book", marker = "extra == 'dev'", specifier = ">=1.0.0" }, + { name = "jupyter-book", marker = "extra == 'dev'", specifier = "==1.0.0" }, { name = "mypy", marker = "extra == 'dev'", specifier = ">=1.4.1" }, { name = "nbqa", marker = "extra == 'dev'", specifier = ">=1.7.1" }, { name = "nbstripout", marker = "extra == 'dev'", specifier = ">=0.6.1" },