Skip to content

Commit bc5118f

Browse files
committed
pypi workflow added
1 parent f8b318f commit bc5118f

File tree

6 files changed

+47
-23
lines changed

6 files changed

+47
-23
lines changed

.github/workflows/publish.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Upload Python Package to PyPI when a Release is Created
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
pypi-publish:
9+
name: Publish release to PyPI
10+
runs-on: ubuntu-latest
11+
environment:
12+
name: pypi
13+
url: https://pypi.org/p/pointextract
14+
permissions:
15+
id-token: write
16+
steps:
17+
- uses: actions/checkout@v4
18+
- name: Set up Python
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: "3.x"
22+
- name: Install dependencies
23+
run: |
24+
python -m pip install --upgrade pip
25+
pip install setuptools wheel
26+
- name: Build package
27+
run: |
28+
python setup.py sdist bdist_wheel # Could also be python -m build
29+
- name: Publish package distributions to PyPI
30+
uses: pypa/gh-action-pypi-publish@release/v1
31+
with:
32+
password: ${{ secrets.PYPI_API_TOKEN }}

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Polar to cartesian transforms using annular point sampling
44
Designed to unwrap 2D cross section images of 3D X-ray computed tomography scans.
55
The topological transformation enables the surface of a circular or elliptical object to be aligned for downsteam analysis.
66

7-
<img src="./docs/workflow.png" width="800">
7+
<img src="./docs/workflow.png" width="700">
88

99
## Installation
1010

@@ -34,6 +34,6 @@ This package is still in early development. Please feel free to post to the GitH
3434
## Acknowledgements
3535
This material is based upon research in the Materials Data Science for Stockpile Stewardship Center of Excellence (MDS3-COE).
3636

37-
[Case Western Reserve University, SDLElab] [1]
37+
<cite> [Case Western Reserve University, SDLElab] [1]</cite>
3838

3939
[1]: http://sdle.case.edu

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Polar to cartesian transforms using annular point sampling.
55
Designed to unwrap 2D cross section images of 3D X-ray computed tomography scans.
66
The topological transformation enables the surface of a circular or elliptical object to be aligned for downsteam analysis.
77

8-
![](workflow.png)
8+
<img src="workflow.png" width="700">
99

1010
## Installation
1111

pointextract/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
from .main import ellipse_detect, unwrap_image
1+
from .main import *

pyproject.toml

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,34 @@
11
[build-system]
2-
requires = ["setuptools >= 61.0"]
2+
requires = ["setuptools>=64", "setuptools_scm>=8"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
66
name = 'pointextract'
7-
version = "0.1"
8-
description = "Polar to cartesian transforms using circular and elliptical point sampling."
9-
7+
dynamic = ["version"]
8+
authors = [
9+
{name = "Thomas Ciardi", email = "thomas.ciardi@case.edu"},
10+
{name = "Roger H. French", email = "rxf131@case.edu"},
11+
]
12+
description = "Polar to cartesian transforms using annular point sampling."
1013
readme = "README.md"
1114
requires-python = ">=3.9"
1215
dependencies = [
1316
'numpy',
1417
'scikit-image',
1518
]
16-
1719
license = {file = "LICENSE"}
18-
1920
classifiers = [
20-
'Development Status :: 4 - Beta',
21+
'Programming Language :: Python :: 3',
2122
'License :: OSI Approved :: BSD License',
2223
'Operating System :: OS Independent',
23-
'Intended Audience :: Science/Research',
24-
'Programming Language :: Python',
25-
'Programming Language :: Python :: 3',
26-
'Topic :: Scientific/Engineering',
27-
]
28-
29-
authors = [
30-
{name = "Thomas Ciardi", email = "thomas.ciardi@case.edu"},
31-
{name = "Roger H. French", email = "rxf131@case.edu"},
3224
]
3325

3426
[project.optional-dependencies]
3527
test = ["pytest"]
3628

3729
[project.urls]
38-
"Bug Tracker" = "https://github.com/cwru-sdle/pointextract/issues"
3930
"Source Code" = "https://github.com/cwru-sdle/pointextract"
31+
"Bug Tracker" = "https://github.com/cwru-sdle/pointextract/issues"
4032

4133
[tool.setuptools.packages.find]
4234
include = ["pointextract*"]

requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
numpy==2.1.2
2-
scikit-image==0.24.0
1+
numpy
2+
scikit-image

0 commit comments

Comments
 (0)