Updata data for 0.1.0 release

.github/workflows/check-links.yaml

@@ -0,0 +1,22 @@
+name: Check links in markdown
+
+on: push
+
+jobs:
+  test_links_in_readme:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: List files
+        run: ls -la
+      - uses: docker://pandoc/core:2.9
+        with:
+          args: >- # allows you to break string into multiple lines
+            --standalone
+            --from markdown
+            --output=readme.html
+            README.md
+      - name: Run htmltest
+        uses: wjdp/htmltest-action@master
+        with:
+          path: readme.html

.github/workflows/run-tests.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12.0-beta.3"]
 
     steps:
       - uses: szenius/set-timezone@v1.1

.gitignore

@@ -1,4 +1,8 @@
+build
+dist
 __pycache__
 .python-version
-build/
-*.egg-info/
+.mypy_cache
+.pytest_cache
+pymvr.egg-info/
+devel/

CHANGELOG.md

@@ -0,0 +1,4 @@
+### Changelog
+
+#### Version 0.1.0
+* Initial release 

README.md

@@ -1,16 +1,28 @@
 # python-mvr
 
-Python library for MVR (My Virtual Rig) which is part of [GDTF (General Device Type Format)](https://gdtf-share.com/)
+Python library for MVR (My Virtual Rig). MVR is part of [GDTF (General Device Type Format)](https://gdtf-share.com/)
 
 MVR specification as per https://gdtf.eu/mvr/prologue/introduction/
 
 See source code for documentation. Naming conventions, in general, are
-identical to that on the GDTF developer wiki, except CamelCase is replaced with
+identical to that on the GDTF, CamelCase is replaced with
 underscore_delimiters.
 
+[Source code](https://github.com/open-stage/python-mvr)
+
+[PyPi page](https://pypi.org/project/pymvr/)
+
+[![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)
+
+[![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)
+
 ## Installation
 
-To install from git, run pip:
+```bash
+pip install pymvr
+```
+
+To install latest version from git via pip:
 ```python
 python -m pip install https://codeload.github.com/open-stage/python-mvr/zip/refs/heads/master
 ```
@@ -19,7 +31,10 @@ python -m pip install https://codeload.github.com/open-stage/python-mvr/zip/refs
 
 ```python
 import pymvr
-mvr=pymvr.GeneralSceneDescription("mvr_file.mvr")
+mvr_scene = pymvr.GeneralSceneDescription("mvr_file.mvr")
+
+for layer_index, layer in enumerate(mvr_scene.layers):
+    ... #process data
 ```
 
 See [BlenderDMX](https://github.com/open-stage/blender-dmx) and

RELEASE.md

@@ -0,0 +1,25 @@
+## Releasing to pypi
+
+* update CHANGELOG.md
+* increment version in setup.py
+* push to master (via PR)
+* `git tag versionCode`
+* `git push origin versionCode`
+
+* generate wheel:
+
+```bash
+python3 setup.py sdist bdist_wheel
+```
+* test upload to TestPypi with twine
+* use `__token__` for username and a token for password
+
+```bash
+python -m twine upload --repository testpypi dist/* --verbose
+```
+
+* release to official pypi:
+
+```bash
+python -m twine upload dist/*
+```

pymvr/__init__.py

@@ -2,7 +2,7 @@
 from xml.etree import ElementTree
 from xml.etree.ElementTree import Element
 import zipfile
-from pymvr.value import *
+from pymvr.value import Matrix, ColorCIE
 
 
 def _find_root(pkg: "zipfile.ZipFile") -> "ElementTree.Element":
@@ -57,7 +57,6 @@ def __init__(self, xml_node: "Element" = None):
             self._read_xml(xml_node)
 
     def _read_xml(self, xml_node: "Element"):
-        print("base node")
         pass
 
 

pymvr/value.py

@@ -1,4 +1,3 @@
-from collections import namedtuple
 from typing import List, Union
 
 

setup.py

@@ -1,14 +1,21 @@
 from setuptools import setup
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
 
 setup(
-    name='pymvr',
-    version='0.0.1',
-    description='My Virtual Rig library',
-    long_description='Basic library for interfacing with the My Virtual Rig format developed by MA, Robe and '
-                     'Vectorworks. For more information on the format see gdtf-share.com',
-    license='MIT',
-    author='vanous',
-    author_email='noreply@nodomain.com',
-    packages=['pymvr']
+    name="pymvr",
+    version="0.1.0",
+    long_description=long_description,
+    description="My Virtual Rig library for Python",
+    long_description_content_type="text/markdown",
+    url="https://github.com/open-stage/python-mvr",
+    license="MIT",
+    author="vanous",
+    author_email="noreply@nodomain.com",
+    packages=["pymvr"],
+    project_urls={
+        "Source": "https://github.com/open-stage/python-mvr",
+        "Changelog": "https://github.com/open-stage/python-mvr/blob/master/CHANGELOG.md",
+    },
 )