[scroll-renderer] PyPI workflow

.github/workflows/scroll-renderer.yml

@@ -0,0 +1,43 @@
+name: Publish Scroll Renderer to PyPI
+
+on:
+  push:
+    tags:
+      - 'scroll-renderer-v*'
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Publish Scroll Renderer to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    defaults:
+      run:
+        working-directory: ./scroll-renderer
+
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python environment
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel build
+
+      - name: Build the package
+        run: |
+          python -m build --sdist --wheel
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: scroll-renderer/dist
+          password: ${{ secrets.PYPI_API_TOKEN }}

scroll-renderer/README.md

@@ -11,16 +11,20 @@ It is recommended to run this package in a Conda environment to manage dependenc
 
 ## Installation
 
-1. Clone the repository and navigate to the project directory:
+2. Install with pip and accept `vesuvius` terms:
 
    ```bash
-   git clone https://github.com/your-repo/scroll_renderer.git
-   cd scroll_renderer
+   pip install scroll-renderer
+   vesuvius.accept_terms --yes
    ```
 
-2. Install the package in editable mode and accept `vesuvius` terms:
+You can also install the package in editable mode:
+
+2. Clone the repository and navigate to the project directory, install and accept `vesuvius` terms:
 
    ```bash
+   git clone https://github.com/your-repo/scroll_renderer.git
+   cd scroll_renderer
    pip install -e .
    vesuvius.accept_terms --yes
    ```

scroll-renderer/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

scroll-renderer/setup.py

@@ -3,9 +3,13 @@
 
 from setuptools import setup, find_packages
 
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
 setup(
     name='scroll_renderer',
-    version='0.0.2',
+    version='0.0.2a',
     packages=find_packages(),
     install_requires=[
         'numpy',
@@ -35,8 +39,18 @@
     },
     author='Vesuvius Challenge Team',
     author_email='[email protected]',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url='https://github.com/ScrollPrize/villa',
     description='A package for flattening and rendering 3D meshes of segments of the Herculaneum Papyri.',
     classifiers=[
         'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.11',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Science/Research',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Scientific/Engineering',
     ],
 )