Skip to content

Commit 91b06e1

Browse files
committed
Update documentation
1 parent 5965fb4 commit 91b06e1

2 files changed

Lines changed: 16 additions & 35 deletions

File tree

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,30 @@ MVR specification as per https://gdtf.eu/mvr/prologue/introduction/
66

77
See source code for documentation. Naming conventions, in general, are
88
identical to that on the GDTF, CamelCase is replaced with
9-
underscore_delimiters.
9+
underscore\_delimiters.
1010

11-
Used for example by [BlenderDMX](https://github.com/open-stage/blender-dmx).
11+
This library is used for example by [BlenderDMX](https://blenderdmx.eu)
12+
([BlenderDMX on GitHub](https://github.com/open-stage/blender-dmx)).
1213

13-
[Source code](https://github.com/open-stage/python-mvr)
14-
15-
[PyPi page](https://pypi.org/project/pymvr/)
14+
[GitHub Page](https://github.com/open-stage/python-mvr), [PyPi Page](https://pypi.org/project/pymvr/)
1615

1716
[![Pytest](https://github.com/open-stage/python-mvr/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/open-stage/python-mvr/actions/workflows/run-tests.yaml)
1817
[![Check links in markdown](https://github.com/open-stage/python-mvr/actions/workflows/check-links.yaml/badge.svg)](https://github.com/open-stage/python-mvr/actions/workflows/check-links.yaml)
1918
![GitHub Tag](https://img.shields.io/github/v/tag/open-stage/python-mvr)
2019

20+
## Status
21+
22+
- Reading and Writing of most aspects of MVR should be covered.
23+
2124
## Installation
2225

23-
- with uv:
26+
- With uv:
2427

2528
```bash
2629
uv add pymvr
2730
```
2831

29-
- with pip
32+
- With pip
3033

3134
```bash
3235
pip install pymvr
@@ -130,10 +133,6 @@ See [BlenderDMX](https://github.com/open-stage/blender-dmx) and
130133
[tests](https://github.com/open-stage/python-mvr/tree/master/tests) for
131134
reference implementation.
132135

133-
## Status
134-
135-
- Reading and Writing of all aspects of MVR should be covered.
136-
137136
## Development
138137

139138
PRs appreciated. You can use [uv](https://docs.astral.sh/uv/) to get the
@@ -161,13 +160,13 @@ uv run pre-commit install
161160

162161
### Testing
163162

164-
- to test, use pytest
163+
- To test, use pytest
165164

166165
```bash
167166
uv run pytest
168167
```
169168

170-
- to test typing with mypy use:
169+
- To test typing with mypy use:
171170

172171
```bash
173172
uv run pytest --mypy -m mypy pymvr/*py

RELEASE.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,23 @@
1111
* Update headers:
1212
* `hawkeye format`
1313

14-
* generate wheel with pip wheel:
15-
16-
```bash
17-
python -m pip install pip wheel twine
18-
python3 -m pip wheel .
19-
```
20-
21-
* generate wheel with uv:
14+
* generate wheel:
2215
- https://docs.astral.sh/uv/
2316

2417
```bash
2518
uv build
2619
```
2720

28-
* test upload to TestPypi with twine:
29-
* use `__token__` for username and a token for password
30-
31-
```bash
32-
python -m twine upload --repository testpypi ./pymvr*whl --verbose
33-
```
34-
35-
* test upload to TestPypi with uv:
36-
* use token for -t
21+
* test upload to TestPypi:
22+
* use \_\_token\_\_ for username
3723

3824
``bash
3925
uv publish -t --publish-url https://test.pypi.org/legacy/ dist/*whl
4026
```
4127
42-
* release to official pypi with twine:
43-
44-
```bash
45-
python -m twine upload ./pymvr*whl
46-
```
4728
4829
* release to official pypi with uv:
30+
* use \_\_token\_\_ for username
4931
5032
```bash
5133
uv publish -t --publish-url https://upload.pypi.org/legacy/ dist/*whl

0 commit comments

Comments
 (0)