Merge pull request #30 from Imageomics/pypi-wf

Set up PyPI workflow

Author: egrace479

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,35 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distribution 📦 to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python3 -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

CITATION.cff

@@ -23,6 +23,13 @@ authors:
     affiliation: Imageomics Institute
     orcid: 'https://orcid.org/0000-0003-0846-2413'
 repository-code: 'https://github.com/Imageomics/distributed-downloader'
+identifiers:
+  - description: "The GitHub release URL of tag v0.2.0-beta."
+    type: url
+    value: "https://github.com/Imageomics/distributed-downloader/releases/tag/v0.2.0-beta"
+  - description: "The GitHub URL of the commit tagged with v0.2.0-beta."
+    type: url
+    value: "https://github.com/Imageomics/distributed-downloader/tree/<commit-hash>" # update post release
 abstract: >-
   MPI-based distributed downloading tool for retrieving data
   from diverse domains.
@@ -34,6 +41,5 @@ keywords:
   - "dataset generation"
   - "MPI application"
 license: MIT
-commit: a38107246515493df93cd61e6612dd7933814b6d
-version: 0.0.1
-date-released: '2025-02-27'
+version: 0.2.0-beta
+date-released: '2025-04-17'

README.md

@@ -24,15 +24,15 @@ in [issue #1](https://github.com/Imageomics/distributed-downloader/issues/1)).
 
 ### Pip installation
 
-1. Install Python 3.10 or higher
+1. Install Python 3.10 or 3.11
 2. Install MPI, any MPI should work, tested with OpenMPI and IntelMPI. Installation instructions can be found on
    official websites:
     - [OpenMPI](https://docs.open-mpi.org/en/v5.0.x/installing-open-mpi/quickstart.html)
     - [IntelMPI](https://www.intel.com/content/www/us/en/docs/mpi-library/developer-guide-linux/2021-6/installation.html)
 3. Install the required package:
     - For general use:
       ```commandline
-      pip install git+https://github.com/Imageomics/distributed-downloader
+      pip install distributed-downloader
       ```
     - For development:
       ```commandline

environment.yaml

@@ -3,7 +3,7 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - python>=3.10 <=3.12
+  - python>=3.10 <3.12
   - attrs
   - brotli
   - cramjam
@@ -34,4 +34,4 @@ dependencies:
   - wheel
   # Development dependencies
   - pytest
-  - ruff
+  - ruff

pyproject.toml

@@ -13,11 +13,14 @@ authors = [
     { name = "Elizabeth G. Campolongo", email = "[email protected]" },
     { name = "Matthew J. Thompson", email = "[email protected]" },
 ]
-description = "A tool for downloading files from a list of URLs in parallel."
+description = "MPI-based tool for downloading images from a list of URLs in parallel."
 readme = "README.md"
-requires-python = ">=3.10, <=3.12"
+requires-python = ">=3.10, <3.12"
 classifiers = [
+    Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
@@ -62,6 +65,8 @@ keywords = [
     "distributed",
     "download",
     "url",
+    "mpi-applications",
+    "dataset-generation",
 ]
 
 [project.urls]

src/distributed_downloader/core/__about__.py

@@ -1 +1 @@
-__version__ = "0.1.0-alpha"
+__version__ = "0.2.0-beta"