Add release instructions, fix pypi project description images, bump version

This commit is contained in:
Tim O'Donnell
2025-11-18 11:31:36 -05:00
parent f5275240f1
commit be03083cf9
3 changed files with 27 additions and 3 deletions

16
PYPI_DESCRIPTION.md Normal file
View File

@@ -0,0 +1,16 @@
<div align="center">
<div>&nbsp;</div>
<img src="https://raw.githubusercontent.com/HannesStark/boltzgen/main/assets/boltzgen.png" alt="BoltzGen logo" width="60%">
[Paper](https://hannes-stark.com/assets/boltzgen.pdf) |
[Slack](https://boltz.bio/join-slack) <br> <br>
![alt text](https://raw.githubusercontent.com/HannesStark/boltzgen/main/assets/cover.png)
</div>
# Installation
In an environment with python >=3.11:
```bash
pip install boltzgen
```
For more details see the [GitHub](https://github.com/HannesStark/boltzgen/tree/main).

8
RELEASE.md Normal file
View File

@@ -0,0 +1,8 @@
### Release process
- Update the version in `pyproject.toml` (e.g., `0.2.0`).
- Create a GitHub release:
- Tag the release as `vX.Y.Z` (e.g., `v0.2.0`) matching the version in `pyproject.toml`.
- Note: we dont auto-check this; keep them in sync.
- Publishing the GitHub release will automatically publish to PyPI via a GitHub Action.

View File

@@ -8,9 +8,9 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "boltzgen" name = "boltzgen"
requires-python = ">=3.9" requires-python = ">=3.11"
version = "0.1.4" version = "0.1.5"
readme = "README.md" readme = { file = "PYPI_DESCRIPTION.md", content-type = "text/markdown" }
description = "Protein design" description = "Protein design"
dependencies = [ dependencies = [
# Add runtime dependencies here # Add runtime dependencies here