Merge pull request #16 from acplt/update/readme

Update README and set PYTHONPATH in compliance tool tests

Author: FrankSchnicke

.github/workflows/ci.yml

@@ -38,9 +38,7 @@ jobs:
       run: |
         python test/_helper/setup_testdb.py -u "admin" -p "$COUCHDB_ADMIN_PASSWORD"
     - name: Test with coverage + unittest
-      # Add source directory to PYTHONPATH to allow testing our CLI scripts, which import our modules
       run: |
-        export PYTHONPATH=".:$PYTHONPATH"
         coverage run --source=basyx -m unittest
     - name: Report test coverage
       if: ${{ always() }}

README.md

@@ -130,10 +130,14 @@ For further examples and tutorials, check out the `basyx.aas.examples`-package.
 * [`tutorial_backend_couchdb`](./basyx/aas/examples/tutorial_backend_couchdb.py): Use the *Backends* interface (`update()/commit()` methods) to manage and retrieve AAS objects in a CouchDB document database
 
 
+### Documentation
+
+A detailed, complete API documentation is available on Read the Docs: https://basyx-python-sdk.readthedocs.io
+
 ### Compliance Tool
 
 The Eclipse BaSyx Python SDK project contains a compliance tool for testing xml and json files is provided in the 
-`aas.compliance_tool`-package. Following functionalities are supported:
+`basyx.aas.compliance_tool`-package. Following functionalities are supported:
 
 * create an xml or json file compliant to the official schema containing example Asset Administration Shell elements
 * create an aasx file with xml or json files compliant to the official schema containing example Asset Administration 
@@ -143,11 +147,11 @@ Shell elements
 * check if the data in a given xml, json or aasx file is the same as the example data
 * check if two given xml, json or aasx files contain the same Asset Administration Shell elements in any order 
 
-Invoking should work with either `python -m aas.compliance_tool.cli` or (when installed correctly and PATH is set 
+Invoking should work with either `python -m basyx.aas.compliance_tool.cli` or (when installed correctly and PATH is set 
 correctly) with `aas-compliance-check` on the command line.
 
-For further usage information consider the `aas.compliance_tool`-package or invoke with 
-`python -m aas.compliance_tool.cli --help` respectively `aas-compliance-check --help`.
+For further usage information consider the `basyx.aas.compliance_tool`-package or invoke with 
+`python -m basyx.aas.compliance_tool.cli --help` respectively `aas-compliance-check --help`.
 
 ## Development
 
@@ -164,15 +168,20 @@ pip install mypy pycodestyle
 
 Running all checks:
 ```bash
-mypy aas test
-pycodestyle --max-line-length 120 aas test
+mypy basyx test
+pycodestyle --max-line-length 120 basyx test
 python -m unittest
 ```
 
 We aim to cover our code with test by at least 80%. To check test coverage, you can use `coverage`:
 
 ```bash
 pip install coverage
-coverage run --source aas --branch -m unittest
+coverage run --source basyx --branch -m unittest
 coverage report -m
 ```
+
+### Eclipse Contributor Agreement
+
+To contribute code to this project you need to sign the [Eclipse Contributor Agreement (ECA)](https://www.eclipse.org/legal/ECA.php).
+This is done by creating an Eclipse account for your git e-mail address and then submitting the following form: https://accounts.eclipse.org/user/eca