Hatch to manage Python virtualenvs #87
Conversation
README.md
Outdated
| ``` | ||
| pip install maturin | ||
| python -m hatch run maturin develop |
There was a problem hiding this comment.
I think it is a bit too much to always prepend python -m:
| python -m hatch run maturin develop | |
| hatch run maturin develop |
There was a problem hiding this comment.
Did you get a binary on your path when you installed hatch? I have Python 3.9.11 via pyenv as my default python (WSL OS). When I python -m pip install hatch, I can use python -m hatch afterwards but hatch is not found. I was going to actually drop a note on the hatch repo saying their docs seemed inconsistent with my experience.
There was a problem hiding this comment.
Yes, hatch is in my path. Maybe worth opening an issue there?
There was a problem hiding this comment.
yep I'll bring it up, switched the examples to use hatch and put a caveat next to the CONDA env caveat
Co-authored-by: David Brochart <[email protected]>
Co-authored-by: David Brochart <[email protected]>
Co-authored-by: David Brochart <[email protected]>
Co-authored-by: David Brochart <[email protected]>
|
I think we need to update the GitHub workflows. |
Yep, up to you if you want it in this PR or a follow-up. I don't think I'll get to it until the weekend. 👍 from me if you want to merge this and update actions later, or if you want to edit this PR directly yourself, or just wait on it. |
|
I'm fine with waiting, there is no rush. That also lets time for other reviewers to chime in. |
| - name: Run Tests | ||
| run: | | ||
| pip install pytest | ||
| pytest | ||
| hatch run pytest |
There was a problem hiding this comment.
I'm not sure what happens if we try hatch run test:pytest here, presumably since there's only one version of Python on the runner then it's effectively the same as hatch run pytest.
README.md
Outdated
| 0. [Install Rust](https://www.rust-lang.org/tools/install) and [Python](https://www.python.org/downloads/) | ||
| - Some alternative bootstrapping options are [pyenv](https://github.com/pyenv/pyenv) for Python, or using [mamba](https://github.com/conda-forge/miniforge) to `mamba install rust python`. | ||
| 1. Install [hatch](https://hatch.pypa.io/latest/install/) (`python -m pip install hatch`) | ||
| 2. Create a development build of the library |
There was a problem hiding this comment.
Maybe we should remain agnostic to the users' package manager of choice in the setup. If we provide the default instructions with pip and have a pyproject.toml, more advanced users will be able to leverage it regardless of whether they are using poetry or hatch
There was a problem hiding this comment.
I'm good with whatever wording you want to use here. I think the original docs got across the point that you need bootstrapping before being able to build ypy, and these do as well.
There was a problem hiding this comment.
Just for this section, lets keep it simple and use the pip instructions. We can keep the alternative bootstrapping section and link out to hatch docs in case people need extra assistance.
There was a problem hiding this comment.
I'm not entirely sure what tweaks you're asking for but I'm 👍 if you want to commit directly to the PR with the wording you'd like to see here. I think this may be the last item to resolve in the PR?
README.md
Outdated
| ## Tests | ||
|
|
||
| All tests are located in `/tests`. You can run them with `pytest`. | ||
| All tests are located in `/tests`. There is a `test` environment matrix defined in `pyproject.toml` that will run `pytest` against `py37` through `py310`. |
pyproject.toml
Outdated
| [[tool.hatch.envs.test.matrix]] | ||
| python = ["37", "38", "39", "310"] |
There was a problem hiding this comment.
Related to my comment above, lets keep the support for hatch within the build system. So this is great!
|
I kept the |
Alternative to, and closes #86 if you prefer this one.
Use
hatchto manage Python virtualenv when developing instead of manually creating one or re-using a system Python.This is what I'm seeing in the wheel metadata after building
