Skip to content

Commit 8bbece4

Browse files
committed
Fix jack_build.py, use in CI, update docs
1 parent 352d505 commit 8bbece4

File tree

4 files changed

+15
-13
lines changed

4 files changed

+15
-13
lines changed

.github/workflows/test.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
- os: ubuntu-latest
1414
jack: jackd1
1515
# x86_64:
16-
- os: macos-13
16+
- os: macos-15-intel
1717
# arm64:
1818
- os: macos-latest
1919
- os: windows-latest
@@ -48,6 +48,7 @@ jobs:
4848
- name: Install Python package
4949
run: |
5050
uv sync --locked
51+
uv run jack_build.py
5152
- name: Run tests
5253
run: |
5354
uv run pytest

CONTRIBUTING.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ newest development version from Github_::
1111

1212
git clone https://github.com/spatialaudio/jackclient-python.git
1313
cd jackclient-python
14-
python3 -m pip install -e .
14+
python -m pip install -e .
15+
python jack_build.py
1516

1617
... where ``-e`` stands for ``--editable``.
1718
This way, your installation always stays up-to-date, even if you pull new
@@ -29,24 +30,24 @@ If you make changes to the documentation, you can locally re-create the HTML
2930
pages using Sphinx_.
3031
You can install it and a few other necessary packages with::
3132

32-
python3 -m pip install -r doc/requirements.txt
33+
python -m pip install -r doc/requirements.txt
3334

3435
To create the HTML pages, use::
3536

36-
python3 setup.py build_sphinx
37+
python -m sphinx doc _build
3738

38-
The generated files will be available in the directory ``build/sphinx/html/``.
39+
The generated files will be available in the directory ``_build/``.
3940

4041
.. _Sphinx: https://www.sphinx-doc.org/
4142

4243
There are no proper tests (yet?), but the code examples from the README file
4344
can be verified with pytest_.
4445
If you haven't installed it already, you can install it with::
4546

46-
python3 -m pip install pytest
47+
python -m pip install pytest
4748

4849
As soon as pytest_ is installed, you can run the (rudimentary) tests with::
4950

50-
python3 -m pytest
51+
python -m pytest
5152

5253
.. _pytest: https://pytest.org/

doc/installation.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ Installation
66

77
You can use ``pip`` to install the ``jack`` module::
88

9-
python3 -m pip install JACK-Client
9+
python -m pip install JACK-Client
1010

1111
Depending on your Python installation (see `Requirements`_ below),
12-
you may have to use ``python`` instead of ``python3``.
12+
you may have to use ``python3`` instead of ``python``.
1313
If you have installed the module already, you can use the ``--upgrade`` flag to
1414
get the newest release.
1515

1616
To un-install, use::
1717

18-
python3 -m pip uninstall JACK-Client
18+
python -m pip uninstall JACK-Client
1919

2020
Requirements
2121
------------
@@ -38,7 +38,7 @@ pip/setuptools:
3838
page.
3939
If you happen to have ``pip`` but not ``setuptools``, use this command::
4040

41-
python3 -m pip install setuptools
41+
python -m pip install setuptools
4242

4343
To upgrade to a newer version of an already installed package (including
4444
``pip`` itself), use the ``--upgrade`` flag.
@@ -71,7 +71,7 @@ NumPy (optional):
7171
You can also install NumPy with ``pip``, but depending on your platform, this
7272
might require a compiler and several additional libraries::
7373

74-
python3 -m pip install NumPy
74+
python -m pip install NumPy
7575

7676
.. _JACK: https://jackaudio.org/
7777
.. _NumPy: https://numpy.org/

jack_build.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,4 +318,4 @@
318318
""", packed=True)
319319

320320
if __name__ == '__main__':
321-
ffibuilder.compile(verbose=True)
321+
ffibuilder.compile(tmpdir='src', verbose=True)

0 commit comments

Comments
 (0)