Skip to content

fix: install Hatch with development dependencies #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daradocaj wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: install Hatch with development dependencies #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,8 @@ This library is packaged with examples that can be downloaded via the doc websit

1. **PyPI maintainer access**: You must be added as a maintainer on the [biolearn PyPI project](https://pypi.org/project/biolearn/). Contact an existing maintainer to be added.
2. **PyPI API token**: Generate a project-scoped API token at [pypi.org/manage/account/token](https://pypi.org/manage/account/token/). Scope it to the `biolearn` project only.
3. **Hatch**: Install the build/publish tool globally:
```bash
pipx install hatch
```
3. **Development environment**: Complete the [setup](#setup) steps. The
development dependencies include Hatch, the build and publishing tool.

### Versioning

Expand Down Expand Up @@ -169,15 +167,15 @@ Tags use the `v` prefix (e.g., `v0.9.0`). You **must** tag before building — o

3. **Build**
```bash
hatch build -c
.venv/bin/hatch build -c
```
Verify the filenames in `dist/` show the correct version with no `dev` suffix.

4. **Publish to PyPI**
```bash
export HATCH_INDEX_USER=__token__
export HATCH_INDEX_AUTH=<your-api-token>
hatch publish
.venv/bin/hatch publish
```

5. **Build and publish documentation**
Expand All @@ -188,5 +186,5 @@ Tags use the `v` prefix (e.g., `v0.9.0`). You **must** tag before building — o
```
Copy the contents of `doc/_build/html/` into the [bio-learn.github.io](https://github.com/bio-learn/bio-learn.github.io) repo and push.

**Note:** The Makefile has a `publish` target (`make publish`) but it references `.venv/bin/hatch` which may not be available. Use a globally installed `hatch` as described above.

**Note:** Once the release artifacts have been verified, `make publish` can be
used to rebuild and publish them in one command.
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ doc = [
# A combination of dependencies useful for developers
dev = [
"biolearn[test,plotting,examples,doc,gpage]",
"hatch",
"jupyterlab",
"scikit-learn",
"torch",
Expand Down