Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Publish to PyPI

on:
release:
types: [published]

jobs:
build:
name: Build distributions
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup uv
uses: astral-sh/setup-uv@v4

- name: Build package
run: uv build

- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: dist-artifacts
path: dist/

publish:
name: Publish to PyPI
runs-on: ubuntu-latest
needs: build
permissions:
id-token: write
environment:
name: pypi
url: https://pypi.org/p/jump-image-datasets
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: dist-artifacts
path: dist/

- name: Publish package
uses: pypa/gh-action-pypi-publish@release/v1
Comment thread
MattsonCam marked this conversation as resolved.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@

## Install

### Install from PyPI

```bash
pip install jump-image-datasets
```

Install from PyPI for stable, versioned releases.

### Local development with uv

```bash
Expand All @@ -23,7 +31,7 @@ uv pip install -e .
pip install "git+https://github.com/WayScience/jump_image_data_downloader.git"
```

This installs the package directly from the latest code, rather than from a PyPI release.
Install from GitHub if you want the latest unreleased changes.

## Usage

Expand Down
7 changes: 5 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[build-system]
requires = ["setuptools>=68", "wheel"]
requires = ["setuptools>=68", "setuptools_scm[toml]>=8", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "jump-image-datasets"
version = "0.1.0"
dynamic = ["version"]
description = "Download and access JUMP image datasets and metadata."
readme = "README.md"
requires-python = ">=3.10"
Expand All @@ -31,6 +31,9 @@ where = ["src"]
[tool.setuptools.package-data]
"jump_image_datasets.jump_pilot" = ["data/*.parquet"]

[tool.setuptools_scm]
tag_regex = "^(?:v)?(?P<version>\\d+\\.\\d+\\.\\d+.*)$"

[dependency-groups]
notebook = [
"jupyter>=1.1.1",
Expand Down
1 change: 0 additions & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading