Skip to content

Commit 105cac3

Browse files
committed
add build from source notes to readme and minor bug fix to build_wheel workflow
1 parent 4ecf6bf commit 105cac3

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

.github/workflows/build_wheel.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ jobs:
9898
runs-on: ubuntu-latest
9999
needs:
100100
- build_wheels
101+
- build_sdist
101102
steps:
102103
- name: Download all distribution artifacts
103104
uses: actions/download-artifact@v5

swmm-toolkit/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
## Community
1818

19-
[![Discord](https://img.shields.io/badge/Discord-Join%20Chat-7289da?logo=discord&logoColor=white)](https://discord.com/channels/1412143058463756421/1412144907312955532)
19+
[![Discord](https://img.shields.io/badge/Discord-Join%20Chat-7289da?logo=discord&logoColor=white)](https://discord.gg/U8wqxgjt9C)
2020

2121
Join the discussion! We will do everything we can to help you!
2222

@@ -37,4 +37,23 @@ Run a SWMM simulation.
3737
from swmm.toolkit import solver
3838
3939
solver.run('input_file.inp', 'report_file.rpt', 'output_file.out')
40+
4041
```
42+
43+
## Build From Source
44+
45+
> [!NOTE]
46+
> Since version version 0.16.1, swmm-toolkit by default has been built and published
47+
> using the [python stable ABI](https://docs.python.org/3/c-api/stable.html#stable-abi) for
48+
> python 3.9 onward. Using the stable ABI introduces very minor performance reduction while
49+
> substantially simplifying our release process and compatibility with future python versions.
50+
>
51+
> The commands below show how to build this package with and without using the python stable ABI.
52+
53+
### Build with python stable ABI
54+
55+
` python -m build .`
56+
57+
### Build without python stable ABI
58+
59+
` NO_STABLE_ABI=1 python -m build`

0 commit comments

Comments
 (0)