Merge branch 'release/doc'

.gitattributes

@@ -114,4 +114,4 @@
 *.pdf  filter=lfs diff=lfs merge=lfs -text
 
 # Disabled
-docs/**/* -filter=lfs -diff=lfs -merge=lfs -text
+# docs/**/* -filter=lfs -diff=lfs -merge=lfs -text

.github/CODE_OF_CONDUCT.md

@@ -43,4 +43,5 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
+
 [version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -1,19 +1,23 @@
 # Contributing To The Neodroid Platform
+
 These guidelines are universal for the entire [Neodroid](https://github.com/sintefneodroid) Platform
 
 ## Pull Requests
+
 We welcome pull requests.
 
 1. Fork the repo and create your branch from `develop`, we are using the git flow branching model.
 2. If you've added code that should be tested, add tests.
 3. If you've changed APIs, update the documentation.
 
 ## Issues
-We use GitHub issues to track public bugs. Please ensure your description is
-clear and has sufficient instructions to be able to reproduce the issue.
+
+We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
 
 ## Coding Style
+
 ...
 
 ## License
+
 By contributing to the [Neodroid](https://github.com/sintefneodroid) platform, you agree that your contributions will be licensed under the LICENSE file in the root directory of this repository.

.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: [cnheider]
+github: [ cnheider ]
 patreon:         cnheider
 open_collective: cnheider
 ko_fi:           cnheider

.github/ISSUE_TEMPLATE.md

@@ -1,21 +1,21 @@
-If you are submitting a feature request, please preface the title with [feature request].
-If you are submitting a bug report, please fill in the following details.
+If you are submitting a feature request, please preface the title with [feature request]. If you are submitting a bug report, please fill in the following details.
 
 ## Issue description
 
 Provide a short description.
 
 ## Code example
 
-Please try to provide a minimal example to reproduce the bug.
-Error messages and stack traces are also helpful.
+Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
 
 ## System Info
+
 Please copy and paste the output from our
 [environment collection script](https://github.com/sintefneodroid/agent/tree/master/.github/utilities/collect_env.py)
 (or fill out the checklist below manually).
 
 You can get the script and run it with:
+
 ```
 wget https://github.com/sintefneodroid/neo/tree/master/.github/utilities/collect_env.py
 # For security purposes, please check the contents of collect_env.py before running it.

.github/workflows/on_push.yml

@@ -5,4 +5,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - uses: cnheider/postdoc@master
+      - uses: pything/postdoc@master

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

@@ -1,45 +1,49 @@
 name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 
-on: push
+on:   push
 
   #on:
-  #push:
+#push:
 #branches: [master]
 
 jobs:
   build-n-publish:
-    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    name:    Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@master
-      - name: Set up Python 3.7
+      - name: Set up Python 3.8
         uses: actions/setup-python@v1
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Install pep517
-        run: >-
+        run:  >-
               python -m
               pip install
               pep517
               --user
       - name: Build a binary wheel and a source tarball
-        run: >-
+        run:  >-
               python -m
               pep517.build
               --source
               --binary
               --out-dir dist/
               .
       - name: Publish distribution 📦 to Test PyPI
-        if: endsWith(github.ref, 'master')
+        env:
+          test_pypi_password: ${{ secrets.test_pypi_secret }}
+        if:   env.test_pypi_password != null && endsWith(github.ref, 'master') && github.repository_owner == 'sintefneodroid'
         uses: pypa/gh-action-pypi-publish@master
         with:
-          password: ${{ secrets.test_pypi_password }}
+          password:       ${{ secrets.test_pypi_secret }}
           repository_url: https://test.pypi.org/legacy/
       - name: Publish distribution 📦 to PyPI
-        if: startsWith(github.ref, 'refs/tags')
+        env:
+          pypi_password: ${{ secrets.pypi_secret }}
+        if:   env.pypi_password != null && startsWith(github.ref, 'refs/tags') && github.repository_owner == 'sintefneodroid'
         uses: pypa/gh-action-pypi-publish@master
         with:
-          password: ${{ secrets.pypi_password }}
+          password: ${{ secrets.pypi_secret }}
           #verbose: true
           #skip_existing: true

.github/workflows/pythonpackage.yml

@@ -0,0 +1,44 @@
+name: Python package
+
+on: [ push ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [ 3.8 ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r requirements/requirements_dev.txt
+          pip install -r requirements/requirements_tests.txt
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Install package
+        run: |
+          pip install -e .[test]
+      - name: Lint with flake8
+        run: |
+          pip install flake8
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          pip install pytest
+          pytest

.pre-commit-config.yaml

@@ -1,6 +1,31 @@
+fail_fast: true
 repos:
   - repo: https://github.com/ambv/black
-    rev:  stable
+    rev:  22.6.0
     hooks:
       - id:               black
-        language_version: python3.7
+        language_version: python3.8
+  - repo: local
+    hooks:
+      - id:             pytest-check
+        name:           pytest-check
+        entry:          pytest
+        language:       system
+        pass_filenames: false
+        always_run:     true
+  - repo: local
+    hooks:
+      - id: flake8-check1 # stop the build if there are Python syntax errors or undefined names
+        name: flake8-check1
+        entry: flake8 neodroidagent --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=*exclude*
+        language: system
+        pass_filenames: false
+        always_run: true
+  - repo: local
+    hooks:
+      - id: flake8-check2  # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        name: flake8-check2
+        entry: flake8 neodroidagent --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude=*exclude*
+        language: system
+        pass_filenames: false
+        always_run: true

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements/requirements_dev.txt

.travis.yml

@@ -1,15 +1,14 @@
 dist:     xenial
 language: python
 python:
-  - '3.6'
-#  - '3.7'
-#  - '3.8'
+  - '3.7'
+  - '3.8'
 install:
   - pip install -r requirements.txt
-  - pip install -r requirements_dev.txt
+  - pip install -r requirements/requirements_dev.txt
   - pip install -e .
 script:
-  - pytest #--cov=warg
+  - pytest --cov=yeet
   - coveralls
-  #- scripts/build_and_upload_package.sh
+  - black --check yeet