Skip to content

Improve readme, add citation block #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vanous merged 2 commits into from
Aug 24, 2025
Merged

Improve readme, add citation block #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5036f90
Improve readme, add citation block
vanous Aug 24, 2025
2b270fe
Add Python 3.14 to tests
vanous Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]

steps:
- uses: szenius/set-timezone@v1.1
Expand Down
27 changes: 20 additions & 7 deletions README.md
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# python-psn

Pure Python parsing library for PSN V2 - [PosiStageNet](https://posistage.net/)
Pure Python parsing library for PSN V2 - [PosiStageNet](https://posistage.net/),[Official PSN specification](https://github.com/vyv/psn-cpp/blob/master/doc/PosiStageNetprotocol_v2.03_2019_09_09.pdf)

[Official PSN specification](https://github.com/vyv/psn-cpp/blob/master/doc/PosiStageNetprotocol_v2.03_2019_09_09.pdf)
This library is used for example by [BlenderDMX](https://blenderdmx.eu)
([BlenderDMX on GitHub](https://github.com/open-stage/blender-dmx)).

[Source code](https://github.com/open-stage/python-psn)

[PyPi page](https://pypi.org/project/pypsn/)
[GitHub Page](https://github.com/open-stage/python-psn), [PyPi page](https://pypi.org/project/pypsn/)

[![Pytest](https://github.com/open-stage/python-psn/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/open-stage/python-psn/actions/workflows/run-tests.yaml)

[![Check links in markdown](https://github.com/open-stage/python-psn/actions/workflows/check-links.yaml/badge.svg)](https://github.com/open-stage/python-psn/actions/workflows/check-links.yaml)
![GitHub Tag](https://img.shields.io/github/v/tag/open-stage/python-psn)

## Installation

Expand Down Expand Up @@ -48,7 +47,7 @@ receiver.stop() # stop receiving

```

### Senfing PSN data
### Sending PSN data
```python
import pypsn

Expand Down Expand Up @@ -117,3 +116,17 @@ mypy pypsn/*py --pretty --no-strict-optional
pytest --mypy -m mypy pypsn/*py
```

## Citation

If you use this library in your research, publication, or software project,
please cite it as follows:

```bibtex
@software{pypsn2025,
title = {pyPSN: Python Library for PosiStageNet},
author = {{OpenStage}},
year = {2025},
version = {0.2.3},
url = {https://github.com/open-stage/python-psn}
}
```