Merge pull request #1 from Project-OMOTES/first_version

First version

.github/workflows/ci.yml

@@ -1,9 +1,9 @@
-name: Build-Test-Lint-etc (linux)
+name: Build (linux)
 
 on: [push]
 
 jobs:
-  build:
+  build-python:
     name: Build the python package
     runs-on: ubuntu-latest
     strategy:

.github/workflows/python_release.yml

@@ -34,3 +34,5 @@ jobs:
 
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: python/dist/

ci/linux/create_venv.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
 
-python3.11 -m venv ./.venv
+python3 -m venv ./.venv
 . .venv/bin/activate
 pip3 install pip-tools

pyproject.toml

@@ -3,6 +3,7 @@ name = "omotes_sdk_protocol_generation"
 dynamic = ["version"]
 authors = [{ name = "Sebastiaan la Fleur", email = "[email protected]" }]
 description = "Maintains and generates the OMOTES SDK protocol in various language."
+readme = "README.md"
 classifiers = [
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Programming Language :: Python :: 3",

python/README.md

@@ -0,0 +1,15 @@
+# OMOTES SDK Protocol
+This package contains the protobuf (proto3) message definitions in Python for the OMOTES SDK protocol.
+This protocol specifies job communication between OMOTES and any user of the SDK.
+
+# Example
+```python
+import uuid
+import datetime
+from omotes_sdk_protocol.job_pb2 import JobSubmission
+
+some_message = JobSubmission(uuid=uuid.uuid4(),
+                             timeout_ms=round(datetime.timedelta(seconds=10).total_seconds() * 1000),
+                             workflow_type="grow_optimizer",
+                             esdl=b'your raw esdl encoded as UTF-8 here')
+```

python/ci/linux/create_venv.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
 
-python3.11 -m venv ./python/.venv
+python3 -m venv ./python/.venv
 . ./python/.venv/bin/activate
 pip3 install pip-tools

python/pyproject.toml

@@ -3,6 +3,7 @@ name = "omotes_sdk_protocol"
 dynamic = ["version"]
 authors = [{ name = "Sebastiaan la Fleur", email = "[email protected]" }]
 description = "Python implementation of OMOTES SDK protocol through which jobs may be submitted and administered. Messages include checking on progress, cancelling a job and receiving status updates."
+readme = "README.md"
 classifiers = [
     "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Programming Language :: Python :: 3",