Updata data for 1.0.3 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

.gitignore

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

CHANGELOG.md

@@ -0,0 +1,25 @@
+### Changelog
+
+#### Version 1.0.3
+* First release under Open-Stage organization
+    * add CI/CD pytest testing + mypy
+* Separating helper methods into utils
+    * support Geometry References
+    * complexity calculation
+    * support Virtual Channels
+* Additional supported objects
+    * DataVersion, MediaServerCamera, Inventory
+    * Wiring Object, DMX Break Overwrite, Geometry Reference
+    * MediaServerLayer, MediaServerMaster
+* Many additional improvements and fixes 
+    * more type hints
+    * default values to ColorCIE
+    * handle missing data (thumbnails, models)
+    * add extension to models
+    * added 1.1 PrimitiveTypes
+
+#### Version 1.0.2
+* Last release to pypi.org from the original author
+
+#### Version 0.1.0
+* First release to pypi.org

README.md

@@ -5,7 +5,7 @@ Python library for [General Device Type Format](https://gdtf-share.com/)
 GDTF specification as per https://gdtf.eu/gdtf/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.
 
 ## Credits
@@ -15,9 +15,21 @@ Page](https://github.com/jackdpage). Forked to
 [Open-Stage](https://github.com/open-stage), used for example by
 [BlenderDMX](https://github.com/open-stage/blender-dmx).
 
+[Source code](https://github.com/open-stage/python-gdtf)
+
+[PyPi page](https://pypi.org/project/pygdtf/)
+
+[![Pytest](https://github.com/open-stage/python-gdtf/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/open-stage/python-gdtf/actions/workflows/run-tests.yaml)
+
+[![Check links in markdown](https://github.com/open-stage/python-gdtf/actions/workflows/check-links.yaml/badge.svg)](https://github.com/open-stage/python-gdtf/actions/workflows/check-links.yaml)
+
 ## Installation
 
-To install latest master from this git repository, run pip:
+```bash
+pip install pygdtf
+```
+
+To install latest version from this git repository, run pip:
 
 ```bash
 python -m pip install https://codeload.github.com/open-stage/python-gdtf/zip/refs/heads/master
@@ -82,10 +94,12 @@ reference implementation.
 
 ## Usage principles
 
-- do not presume that plain layout of DMX Channels in a DMX Mode is defining
-  the DMX footprint of the device. Geometry references are (frequently) used to
-  re-use parts of the device. This means that a channel(s) defined once can be
-  multiplied, over several times duplicated geometry (tree).
+- for list of channels, use `pygdtf.utils.get_dmx_channels` as per example
+  above, do not presume that plain layout of DMX Channels in a DMX Mode is
+  defining the DMX footprint of the device. Geometry references are
+  (frequently) used to re-use parts of the device. This means that a channel(s)
+  defined once can be multiplied, over several times duplicated geometry
+  (tree).
 
 - do not use geometry names for anything related to function of the geometry
   (yoke, pan, tilt, head), use attached GDTF attributes ("Pan", "Tilt")
@@ -97,7 +111,7 @@ reference implementation.
 
 ## Status
 
-- GDTF 1.1 with some small portions of GDTF 1.2 being included
+- GDTF 1.1 with some portions of GDTF 1.2 being included
 
 ## Development
 

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/*
+```

setup.py

@@ -1,14 +1,22 @@
 from setuptools import setup
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 
 setup(
     name="pygdtf",
-    version="1.0.1",
-    description="General Device Type Format library",
-    long_description="Basic library for interfacing with the General Device Type Format developed by MA, Robe and "
-    "Vectorworks. For more information on the format see gdtf-share.com",
+    version="1.0.3",
+    description="General Device Type Format library for Python",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     license="MIT",
-    author="Jack Page",
-    author_email="jdpboc98@gmail.com",
+    author="Jack Page, vanous",
+    author_email="noreply@nodomain.com",
     packages=["pygdtf", "pygdtf.utils"],
+    url="https://github.com/open-stage/python-gdtf",
+    project_urls={
+        "Source": "https://github.com/open-stage/python-gdtf",
+        "Changelog": "https://github.com/open-stage/python-gdtf/blob/master/CHANGELOG.md",
+    },
 )