Skip to content

Commit 02ab9af

Browse files
authored
🤖 Update CI actions to v3 (#28)
1 parent 68ad250 commit 02ab9af

File tree

3 files changed

+19
-10
lines changed

3 files changed

+19
-10
lines changed

‎.github/workflows/python.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
steps:
1616
- uses: actions/checkout@v3
1717
- name: Set up Python 3.8
18-
uses: actions/setup-python@v3
18+
uses: actions/setup-python@v4
1919
with:
2020
python-version: 3.8
2121

@@ -51,7 +51,7 @@ jobs:
5151
steps:
5252
- uses: actions/checkout@v3
5353

54-
- uses: actions/setup-python@v3
54+
- uses: actions/setup-python@v4
5555
name: Install Python
5656
with:
5757
python-version: ${{ matrix.python-version }}
@@ -93,13 +93,13 @@ jobs:
9393
9494
- name: Publish distribution 📦 to Test PyPI
9595
if: ${{ github.ref != 'refs/tags/v1.3.6' }}
96-
uses: pypa/gh-action-pypi-publish@master
96+
uses: pypa/gh-action-pypi-publish@release/v1
9797
with:
9898
password: ${{ secrets.TEST_PYPI_TOKEN }}
9999
repository_url: https://test.pypi.org/legacy/
100100

101101
- name: Publish distribution 📦 to PyPI
102102
if: ${{ github.ref == 'refs/tags/v1.3.6' }}
103-
uses: pypa/gh-action-pypi-publish@master
103+
uses: pypa/gh-action-pypi-publish@release/v1
104104
with:
105105
password: ${{ secrets.PYPI_TOKEN }}

‎README.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,14 @@
1717

1818
## DESCRIPTION
1919

20-
The <strong>SO3</strong> code provides functionality to perform fast and exact Wigner transforms based on the sampling theorem on the rotation group derived in [McEwen et al. (2015)](http://www.jasonmcewen.org/publication/mcewen-so-3/).
20+
The **SO3** code provides functionality to perform fast and exact Wigner transforms
21+
based on the sampling theorem on the rotation group derived in [McEwen et al.
22+
(2015)](http://www.jasonmcewen.org/publication/mcewen-so-3/).
2123

2224
## INSTALLATION
2325

24-
The python package, <strong>so3</strong> (pyso3 was taken), is available on <a href="https://pypi.org/project/so3/">pypi</a> and can be installed with:
26+
The python package, **so3** (pyso3 was taken), is available on
27+
[so3](https://pypi.org/project/so3/") and can be installed with:
2528

2629
```bash
2730
pip install so3
@@ -60,8 +63,8 @@ Usage for the python package is also given in the package docstring.
6063

6164
## REFERENCING
6265

63-
If you use **SO3** for work that results in publication, please reference <a
64-
href="http://github.com/astro-informatics/so3">https://github.com/astro-informatics/so3/</a>
66+
If you use **SO3** for work that results in publication, please reference [the **SO3**
67+
url](http://github.com/astro-informatics/so3)
6568
and cite our related academic paper:
6669

6770
- J. D. McEwen, M. B&uuml;ttner, B. Leistedt, H. V. Peiris, Y. Wiaux, [A novel sampling theorem on the rotation group](http://www.jasonmcewen.org/publication/mcewen-so-3/), IEEE Sig. Proc. Let., 22(12):2425-2429, 2015 [(arXiv:1508.03101)](https://arxiv.org/abs/1508.03101")
@@ -75,5 +78,7 @@ SO3 is released under the GPL-3 license. For further details see
7578

7679
## AUTHORS
7780

78-
**SO3** was initially developed by Martin B&uuml;ttner, <a href="http://www.jasonmcewen.org/">Jason McEwen</a>, and Boris Leistedt but significant contributors have since been made by a number of [others](https://github.com/astro-informatics/so3/graphs/contributors).
79-
</p>
81+
**SO3** was initially developed by Martin Büttner, [Jason
82+
McEwen](http://www.jasonmcewen.org/), and Boris Leistedt but significant contributors
83+
have since been made by a number of
84+
[others](https://github.com/astro-informatics/so3/graphs/contributors).

‎setup.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
from pathlib import Path
2+
13
from skbuild import setup
24

35
cmake_args = [
@@ -31,4 +33,6 @@
3133
cmake_languages=("C",),
3234
license="GPL-3",
3335
packages=["so3"],
36+
long_description=Path(__file__).with_name("README.md").read_text(),
37+
long_description_content_type="text/markdown",
3438
)

0 commit comments

Comments
 (0)