Skip to content

Commit 51b76ec

Browse files
committed
Fix packaging metadata and repository URLs
The four packages carrying the code declared only a name, a description and their dependencies, so each would publish a blank project page with no license, no classifiers and no links, where the umbrella harp package declared all of them. They now carry authors, license, license-files, readme, classifiers and project.urls. Each package keeps its own copy of the license text, since PEP 639 forbids a parent directory reference in license-files and setuptools accepts one while silently shipping no file. Sibling links in the package READMEs are absolute, since a relative link resolves nowhere on a project page. Repository, documentation and raw content URLs follow the rename to harp-tech/python, and mkdocs declares site_url for the first time.
1 parent 28b7143 commit 51b76ec

16 files changed

Lines changed: 210 additions & 19 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
<p align="center">
2-
<img src="https://raw.githubusercontent.com/harp-tech/pyharp/c0c8c23cc1a965c41834a106fe686be76c2f0520/docs/assets/logo.svg" alt="Harp logo" width="400">
2+
<img src="https://raw.githubusercontent.com/harp-tech/python/c0c8c23cc1a965c41834a106fe686be76c2f0520/docs/assets/logo.svg" alt="Harp logo" width="400">
33
</p>
44

55
# harp
66

77
This project includes four main packages:
88

9-
- **harp-protocol**: Provides the core protocol definitions and utilities for the Harp protocol. See [Protocol API Documentation](https://harp-tech.org/pyharp/api/protocol) for details.
9+
- **harp-protocol**: Provides the core protocol definitions and utilities for the Harp protocol. See [Protocol API Documentation](https://harp-tech.org/python/api/protocol) for details.
1010

11-
- **harp-serial**: Implements serial communication functionalities for generic Harp devices. See [Serial API Documentation](https://harp-tech.org/pyharp/api/serial) for more information.
11+
- **harp-serial**: Implements serial communication functionalities for generic Harp devices. See [Serial API Documentation](https://harp-tech.org/python/api/serial) for more information.
1212

13-
- **harp-device**: Implements the transport-agnostic `Device` interface, the common register map, and the shared registers and enums. See [Device API Documentation](https://harp-tech.org/pyharp/api/device) for details.
13+
- **harp-device**: Implements the transport-agnostic `Device` interface, the common register map, and the shared registers and enums. See [Device API Documentation](https://harp-tech.org/python/api/device) for details.
1414

15-
- **harp-data**: Parses register binary dumps into pandas DataFrames. See [Data API Documentation](https://harp-tech.org/pyharp/api/data) for more information.
15+
- **harp-data**: Parses register binary dumps into pandas DataFrames. See [Data API Documentation](https://harp-tech.org/python/api/data) for more information.
1616

1717
## Installation
1818

@@ -100,7 +100,7 @@ AnalogData = behavior.AnalogData # registers are reached by name
100100
assert behavior.REGISTER_MAP[44] is AnalogData # or by address
101101
```
102102

103-
See the [Examples](https://harp-tech.org/pyharp/examples/) for the full walkthroughs, including subscribing to device events and working with custom interface-type converters.
103+
See the [Examples](https://harp-tech.org/python/examples/) for the full walkthroughs, including subscribing to device events and working with custom interface-type converters.
104104

105105
## Contributing
106106

mkdocs.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
site_name: harp
2-
repo_url: https://github.com/harp-tech/pyharp
3-
repo_name: "harp-tech/pyharp"
2+
site_url: https://harp-tech.org/python/
3+
repo_url: https://github.com/harp-tech/python
4+
repo_name: "harp-tech/python"
45
copyright: Copyright (c) harp-tech and Contributors
56

67
exclude_docs: |
@@ -87,7 +88,7 @@ nav:
8788
extra:
8889
social:
8990
- icon: fontawesome/brands/github
90-
link: https://github.com/harp-tech/pyharp
91+
link: https://github.com/harp-tech/python
9192

9293
extra_css:
9394
- stylesheets/extra.css

pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ dependencies = [
3838

3939
[project.urls]
4040
Homepage = "https://harp-tech.org/"
41-
Repository = "https://github.com/harp-tech/pyharp/"
42-
Documentation = "https://harp-tech.org/pyharp/"
43-
"Bug Tracker" = "https://github.com/harp-tech/pyharp/issues"
44-
Changelog = "https://github.com/harp-tech/pyharp/releases"
41+
Repository = "https://github.com/harp-tech/python/"
42+
Documentation = "https://harp-tech.org/python/"
43+
"Bug Tracker" = "https://github.com/harp-tech/python/issues"
44+
Changelog = "https://github.com/harp-tech/python/releases"
4545

4646
[build-system]
4747
requires = ["setuptools>=77", "setuptools-scm>=8"]

src/packages/harp-data/LICENSE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
MIT License
2+
3+
Copyright (c) 2020 OEPS & Filipe Carvalho
4+
Copyright (c) 2025 Hardware and Software Platform, Champalimaud Foundation
5+
Copyright (c) harp-tech and Contributors
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

src/packages/harp-data/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# harp-data
22

3-
Load Harp register data into pandas DataFrames. This is the package that pulls in `pandas`. [`harp-protocol`](../harp-protocol) stays numpy-only and exposes a pandas-free `ColumnData` view that this package assembles into a DataFrame.
3+
Load Harp register data into pandas DataFrames. This is the package that pulls in `pandas`. [`harp-protocol`](https://github.com/harp-tech/python/tree/main/src/packages/harp-protocol) stays numpy-only and exposes a pandas-free `ColumnData` view that this package assembles into a DataFrame.
44

55
There are two ways in, depending on what is on disk:
66

@@ -19,7 +19,7 @@ A Harp acquisition is usually saved as a de-multiplexed folder, one binary file
1919
┗ 📜 device.yml
2020
```
2121

22-
Reading is based on a [device module](../harp-device) that describes how to decode each register. `open_dataset` supplies one automatically. It finds the `device.yml` in the folder, builds the module, and returns a ready-to-use reader:
22+
Reading is based on a [device module](https://github.com/harp-tech/python/tree/main/src/packages/harp-device) that describes how to decode each register. `open_dataset` supplies one automatically. It finds the `device.yml` in the folder, builds the module, and returns a ready-to-use reader:
2323

2424
```python
2525
from harp import data

src/packages/harp-data/pyproject.toml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,39 @@
22
name = "harp-data"
33
dynamic = ["version"]
44
description = "Load Harp device data into pandas DataFrames"
5+
authors = [{ name = "harp-tech", email = "contact@harp-tech.org" }]
6+
license = "MIT"
7+
license-files = ["LICENSE"]
8+
readme = 'README.md'
59
requires-python = ">=3.11"
10+
classifiers = [
11+
"Development Status :: 4 - Beta",
12+
"Intended Audience :: Science/Research",
13+
"Intended Audience :: Developers",
14+
"Operating System :: Microsoft :: Windows",
15+
"Operating System :: POSIX :: Linux",
16+
"Operating System :: MacOS",
17+
"Programming Language :: Python :: 3",
18+
"Programming Language :: Python :: 3.11",
19+
"Programming Language :: Python :: 3.12",
20+
"Programming Language :: Python :: 3.13",
21+
"Topic :: Scientific/Engineering",
22+
"Topic :: System :: Hardware :: Hardware Drivers",
23+
]
624
dependencies = [
725
"harp-protocol",
826
"harp-device",
927
"numpy>=1.24",
1028
"pandas>=2.0",
1129
]
1230

31+
[project.urls]
32+
Homepage = "https://harp-tech.org/"
33+
Repository = "https://github.com/harp-tech/python/"
34+
Documentation = "https://harp-tech.org/python/"
35+
"Bug Tracker" = "https://github.com/harp-tech/python/issues"
36+
Changelog = "https://github.com/harp-tech/python/releases"
37+
1338
[build-system]
1439
requires = ["setuptools>=77", "setuptools-scm>=8"]
1540
build-backend = "setuptools.build_meta"

src/packages/harp-device/LICENSE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
MIT License
2+
3+
Copyright (c) 2020 OEPS & Filipe Carvalho
4+
Copyright (c) 2025 Hardware and Software Platform, Champalimaud Foundation
5+
Copyright (c) harp-tech and Contributors
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

src/packages/harp-device/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# harp-device
22

3-
The transport-agnostic device layer for the Harp protocol: the common Harp registers and a `Device` base that handles framing, request/reply and register access. It depends only on [`harp-protocol`](../harp-protocol), with no transport dependencies. Pair it with a transport such as [`harp-serial`](../harp-serial).
3+
The transport-agnostic device layer for the Harp protocol: the common Harp registers and a `Device` base that handles framing, request/reply and register access. It depends only on [`harp-protocol`](https://github.com/harp-tech/python/tree/main/src/packages/harp-protocol), with no transport dependencies. Pair it with a transport such as [`harp-serial`](https://github.com/harp-tech/python/tree/main/src/packages/harp-serial).
44

55
## Read/write registers
66

src/packages/harp-device/pyproject.toml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,38 @@
22
name = "harp-device"
33
dynamic = ["version"]
44
description = "Transport-agnostic Harp device protocol layer"
5+
authors = [{ name = "harp-tech", email = "contact@harp-tech.org" }]
6+
license = "MIT"
7+
license-files = ["LICENSE"]
8+
readme = 'README.md'
59
requires-python = ">=3.11"
10+
classifiers = [
11+
"Development Status :: 4 - Beta",
12+
"Intended Audience :: Science/Research",
13+
"Intended Audience :: Developers",
14+
"Operating System :: Microsoft :: Windows",
15+
"Operating System :: POSIX :: Linux",
16+
"Operating System :: MacOS",
17+
"Programming Language :: Python :: 3",
18+
"Programming Language :: Python :: 3.11",
19+
"Programming Language :: Python :: 3.12",
20+
"Programming Language :: Python :: 3.13",
21+
"Topic :: Scientific/Engineering",
22+
"Topic :: System :: Hardware :: Hardware Drivers",
23+
]
624
dependencies = [
725
"harp-protocol",
826
"pydantic>=2",
927
"pydantic-yaml>=1",
1028
]
1129

30+
[project.urls]
31+
Homepage = "https://harp-tech.org/"
32+
Repository = "https://github.com/harp-tech/python/"
33+
Documentation = "https://harp-tech.org/python/"
34+
"Bug Tracker" = "https://github.com/harp-tech/python/issues"
35+
Changelog = "https://github.com/harp-tech/python/releases"
36+
1237
[build-system]
1338
requires = ["setuptools>=77", "setuptools-scm>=8"]
1439
build-backend = "setuptools.build_meta"

src/packages/harp-protocol/LICENSE

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
MIT License
2+
3+
Copyright (c) 2020 OEPS & Filipe Carvalho
4+
Copyright (c) 2025 Hardware and Software Platform, Champalimaud Foundation
5+
Copyright (c) harp-tech and Contributors
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

0 commit comments

Comments
 (0)