Skip to content

Commit

Permalink
build(mise): set up optional mise dev environment
Browse files Browse the repository at this point in the history
  • Loading branch information
engeir committed Mar 11, 2024
1 parent ad76671 commit 1c3ccdc
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,4 @@ dmypy.json
.vim/
test.nc
test2.nc
.mise.local.toml
2 changes: 2 additions & 0 deletions .mise.development.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[tools]
python = { version = "3.9", virtualenv = ".venv" }
22 changes: 14 additions & 8 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,29 +43,35 @@ Request features on the `Issue Tracker`_.
How to set up your development environment
------------------------------------------

You need Python 3.6+ and the following tools:
You need Python 3.9+ and the following tools:

- Poetry_
- Rye_
- Nox_
- nox-poetry_

Install the package with development requirements:

.. code:: console
$ poetry install
$ rye sync
You can now run an interactive Python session,
or the command-line interface:

.. code:: console
$ poetry run python
$ poetry run ncdump-rich
$ rye run python
$ rye run ncdump-rich
.. _Poetry: https://python-poetry.org/
Additionally, you can use Mise_ to manage and automatically activate your virtual
environment by running:

.. code:: console
$ mise set MISE_ENV=development
.. _Rye: https://rye-up.com/
.. _Nox: https://nox.thea.codes/
.. _nox-poetry: https://nox-poetry.readthedocs.io/
.. _Mise: https://mise.jdx.dev/


How to test the project
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ rye = { dev-dependencies = [
"sphinx-rtd-theme>=2.0.0",
"typeguard>=4.1.5",
"xdoctest>=1.1.3",
] }
], managed = true }

[tool.coverage.paths]
source = ["src", "*/site-packages"]
Expand Down

0 comments on commit 1c3ccdc

Please sign in to comment.