LinkPython-extern 1.3.0a1__tar.gz → 1.3.0a2__tar.gz

{linkpython_extern-1.3.0a1 → linkpython_extern-1.3.0a2}/PKG-INFO

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: LinkPython-extern
-Version: 1.3.0a1
-Summary: A fork of the LinkPython wrapper for Ableton Link
+Version: 1.3.0a2
+Summary: A Python wrapper for Ableton Link, wheels included!
+Keywords: ableton,ableton link,link,music,sync
 Author: gonzaloflirt
 Maintainer: thegamecracks
 License-Expression: Unlicense
@@ -15,14 +16,44 @@ Project-URL: Homepage, https://github.com/thegamecracks/link-python
 Requires-Python: <3.15,>=3.9
 Description-Content-Type: text/markdown
 
-# Python wrapper for [Ableton Link][1]
+# LinkPython-extern
 
-[![Build](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml)
 [![PyPI](https://img.shields.io/pypi/v/LinkPython-extern?label=View%20on%20pypi&style=flat-square)](https://pypi.org/project/LinkPython-extern/)
+[![Build](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml)
+[![Tests](https://github.com/thegamecracks/link-python/actions/workflows/pytest.yml/badge.svg)](https://github.com/thegamecracks/link-python/actions/workflows/pytest.yml)
+
+A Python wrapper for [Ableton Link], forked from gonzaloflirt's [link-python]
+to streamline the user experience with new methods, type stubs, and pre-built
+wheels.
+
+```py
+from link import Link
+
+link = Link(120)
+clock = link.clock()
+micros = clock.micros()
+
+state = link.captureAppSessionState()
+beat = state.beatAtTime(micros, 4)
+phase = state.phaseAtTime(micros, 4)
+```
+
+You can see the full API documentation in [`__init__.pyi`], or look at
+the [LinkHut.py] example which is equivalent to Ableton Link's
+[linkhut] example.
+
+For asyncio usage, consider trying out the [aalink] project!
+
+## Installation
+
+This project can be installed from PyPI under the [LinkPython-extern] name:
 
-This fork was created to streamline the user experience for installing LinkPython
-by uploading pre-built wheels on PyPI. More information about LinkPython
-can be found [in their repository][2].
+```sh
+pip install LinkPython-extern
+```
+
+Note that we are *not* the same as [LinkPython], which is a different fork
+of link-python by munshkr.
 
 ## Python compatibility
 
@@ -42,15 +73,6 @@ can be found [in their repository][2].
 
 \* CPython 3.13's experimental free-threading builds are not supported.
 
-## Installation
-
-Distributions are available on PyPI with the [LinkPython-extern][3] package.
-Example install command:
-
-```sh
-pip install LinkPython-extern
-```
-
 ## Building from source
 
 If you want to build this package from source, you will need CMake installed.
@@ -70,10 +92,19 @@ git clone --recurse-submodules https://github.com/thegamecracks/link-python
 git submodule update --init --recursive
 ```
 
-## License:
-This depends on [Link][1] and [pybind11][4]. Please mind the licenses of those libraries and their dependencies.
-
-[1]: https://github.com/ableton/link.git
-[2]: https://github.com/gonzaloflirt/link-python
-[3]: https://pypi.org/project/LinkPython-extern/
-[4]: https://github.com/pybind/pybind11
+## License
+
+This project is written under [Unlicense] but also depends on,
+among other libraries, [Ableton Link] and [pybind11].
+Please mind the licenses of those libraries and their dependencies.
+
+[Ableton Link]: https://github.com/ableton/link.git
+[link-python]: https://github.com/gonzaloflirt/link-python
+[`__init__.pyi`]: https://github.com/thegamecracks/link-python/blob/master/src-py/link/__init__.pyi
+[LinkHut.py]: https://github.com/thegamecracks/link-python/blob/master/example/LinkHut.py
+[linkhut]: https://github.com/Ableton/link/blob/master/examples/linkhut/main.cpp
+[aalink]: https://github.com/artfwo/aalink
+[LinkPython-extern]: https://pypi.org/project/LinkPython-extern/
+[LinkPython]: https://github.com/munshkr/link-python
+[Unlicense]: /LICENSE.md
+[pybind11]: https://github.com/pybind/pybind11

{linkpython_extern-1.3.0a1 → linkpython_extern-1.3.0a2}/README.md

@@ -1,11 +1,41 @@
-# Python wrapper for [Ableton Link][1]
+# LinkPython-extern
 
-[![Build](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml)
 [![PyPI](https://img.shields.io/pypi/v/LinkPython-extern?label=View%20on%20pypi&style=flat-square)](https://pypi.org/project/LinkPython-extern/)
+[![Build](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/thegamecracks/link-python/actions/workflows/build_wheels.yml)
+[![Tests](https://github.com/thegamecracks/link-python/actions/workflows/pytest.yml/badge.svg)](https://github.com/thegamecracks/link-python/actions/workflows/pytest.yml)
+
+A Python wrapper for [Ableton Link], forked from gonzaloflirt's [link-python]
+to streamline the user experience with new methods, type stubs, and pre-built
+wheels.
+
+```py
+from link import Link
+
+link = Link(120)
+clock = link.clock()
+micros = clock.micros()
+
+state = link.captureAppSessionState()
+beat = state.beatAtTime(micros, 4)
+phase = state.phaseAtTime(micros, 4)
+```
+
+You can see the full API documentation in [`__init__.pyi`], or look at
+the [LinkHut.py] example which is equivalent to Ableton Link's
+[linkhut] example.
+
+For asyncio usage, consider trying out the [aalink] project!
+
+## Installation
+
+This project can be installed from PyPI under the [LinkPython-extern] name:
 
-This fork was created to streamline the user experience for installing LinkPython
-by uploading pre-built wheels on PyPI. More information about LinkPython
-can be found [in their repository][2].
+```sh
+pip install LinkPython-extern
+```
+
+Note that we are *not* the same as [LinkPython], which is a different fork
+of link-python by munshkr.
 
 ## Python compatibility
 
@@ -25,15 +55,6 @@ can be found [in their repository][2].
 
 \* CPython 3.13's experimental free-threading builds are not supported.
 
-## Installation
-
-Distributions are available on PyPI with the [LinkPython-extern][3] package.
-Example install command:
-
-```sh
-pip install LinkPython-extern
-```
-
 ## Building from source
 
 If you want to build this package from source, you will need CMake installed.
@@ -53,10 +74,19 @@ git clone --recurse-submodules https://github.com/thegamecracks/link-python
 git submodule update --init --recursive
 ```
 
-## License:
-This depends on [Link][1] and [pybind11][4]. Please mind the licenses of those libraries and their dependencies.
+## License
+
+This project is written under [Unlicense] but also depends on,
+among other libraries, [Ableton Link] and [pybind11].
+Please mind the licenses of those libraries and their dependencies.
 
-[1]: https://github.com/ableton/link.git
-[2]: https://github.com/gonzaloflirt/link-python
-[3]: https://pypi.org/project/LinkPython-extern/
-[4]: https://github.com/pybind/pybind11
+[Ableton Link]: https://github.com/ableton/link.git
+[link-python]: https://github.com/gonzaloflirt/link-python
+[`__init__.pyi`]: https://github.com/thegamecracks/link-python/blob/master/src-py/link/__init__.pyi
+[LinkHut.py]: https://github.com/thegamecracks/link-python/blob/master/example/LinkHut.py
+[linkhut]: https://github.com/Ableton/link/blob/master/examples/linkhut/main.cpp
+[aalink]: https://github.com/artfwo/aalink
+[LinkPython-extern]: https://pypi.org/project/LinkPython-extern/
+[LinkPython]: https://github.com/munshkr/link-python
+[Unlicense]: /LICENSE.md
+[pybind11]: https://github.com/pybind/pybind11

{linkpython_extern-1.3.0a1 → linkpython_extern-1.3.0a2}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "LinkPython-extern"
-version = "1.3.0a1"
-description = "A fork of the LinkPython wrapper for Ableton Link"
+version = "1.3.0a2"
+description = "A Python wrapper for Ableton Link, wheels included!"
 requires-python = ">=3.9,<3.15"
 license = "Unlicense"
 license-files = ["LICENSE.md"]
@@ -19,6 +19,13 @@ classifiers = [
     "Programming Language :: Python",
     "Topic :: System :: Networking",
 ]
+keywords = [
+    "ableton",
+    "ableton link",
+    "link",
+    "music",
+    "sync",
+]
 
 [dependency-groups]
 dev = ["pytest>=8.4.2"]

{linkpython_extern-1.3.0a1 → linkpython_extern-1.3.0a2}/uv.lock

@@ -53,7 +53,7 @@ wheels = [
 
 [[package]]
 name = "linkpython-extern"
-version = "1.3.0a1"
+version = "1.3.0a2"
 source = { editable = "." }
 
 [package.dev-dependencies]