Kick off

This is the initial version, ready for first practical trials.

.github/workflows/build-test-docs.yml

@@ -0,0 +1,37 @@
+name: Build-test docs
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+
+jobs:
+  Execute:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10']
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip3 install -e .
+          pip3 install -r docs/requirements.txt
+
+      - name: Build the docs
+        run: |
+          sphinx-build docs/source docs/build
+
+      - name: Test the docs
+        run: |
+          sphinx-build docs/source docs/build -b doctest

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+
+jobs:
+  Check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip3 install --upgrade coveralls
+          pip3 install -e .[dev]
+
+      - name: Run precommit
+        run: |
+          python3 continuous_integration/precommit.py
+
+      - name: Upload Coverage
+        run: coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_FLAG_NAME: ${{ matrix.python-version }}
+          COVERALLS_PARALLEL: true
+
+  Finish-Coveralls:
+    name: Finish Coveralls
+    needs: [Check]
+    runs-on: ubuntu-latest
+    container: python:3-slim
+    steps:
+      - name: Finish Coveralls
+        run: |
+          pip3 install --upgrade coveralls
+          coveralls --finish --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,36 @@
+# Based on https://github.com/actions/starter-workflows/blob/main/ci/python-publish.yml
+name: Publish to Pypi
+
+on:
+  release:
+    types: [created]
+
+  push:
+    branches:
+      - '*/fixed-publishing-to-pypi'
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: "__token__"
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitignore

@@ -1,3 +1,5 @@
+.idea/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+  - requirements: docs/requirements.txt

AUTHORS

@@ -0,0 +1 @@
+Marko Ristin ([email protected], [email protected], [email protected]) for Zurich University of Applied Sciences (ZHAW)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 aas-core-works
+Copyright (c) 2023 aas-core3.0-python-protobuf AUTHORS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+Please see the file AUTHORS for the full list of the authors of aas-core3.0-python-protobuf.

README.md

@@ -1,2 +1,18 @@
 # aas-core3.0-python-protobuf
-Convert AAS instances between Python and Python ProtoBuf objects.
+Convert Asset Administration Shells V3.0 between Python and ProtoBuf objects.
+
+This is a library to convert Asset Administration Shells V3.0 between Python and ProtoBuf objects.
+
+The documentation is available on: https://aas-core30-python-protobuf.readthedocs.io/en/latest/.
+
+The majority of the code has been automatically generated by [aas-core-codegen].
+
+The definitions of the Protocol Buffers are given in [aas-core-protobuf] repository.
+
+If you want to contribute, see our [contributing guide].
+
+[aas-core-codegen]: https://github.com/aas-core-works/aas-core-codegen
+
+[aas-core-protobuf]: https://github.com/aas-core-works/aas-core-protobuf
+
+[contributing guide]: https://aas-core30-python-protobuf.readthedocs.io/en/latest/contributing.html

aas_core3_protobuf/__init__.py

@@ -0,0 +1,7 @@
+"""Convert AAS instances between Python and Python ProtoBuf objects."""
+
+__version__ = "0.0.1"
+__author__ = "Marko Ristin"
+__copyright__ = "2024 Contributors to aas-core3.0-python-protobuf"
+__license__ = "License :: OSI Approved :: MIT License"
+__status__ = "Production/Stable"