Merge pull request #6 from giorgiopizz/devs

A mature version of the framework with support for post processing and shapes

Author: giorgiopizz

.github/workflows/ci_lint_format_test.yml

@@ -0,0 +1,17 @@
+name: tests
+run-name: ${{ github.actor }} is running mkShapesRDF tests 🚀
+on: [push]
+jobs:
+  tests:
+    runs-on: self-hosted
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
+      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - run: |
+            cd ${{ github.workspace }}
+            ./tests/test_env.sh
+      - run: echo "All done"
+      - run: echo "🍏 This job's status is ${{ job.status }}."

.gitignore

@@ -1,2 +1,15 @@
 #*
 .#
+\#*#
+**.root
+**__py*
+*.egg*
+myenv*
+examples/*/*_cc*
+examples/*/*/
+**~
+mkShapesRDF/processor/condor/*
+mkShapesRDF/processor/data/jsonpog*
+start.sh
+*build*
+*html*

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+-   repo: local
+    hooks:
+    -   id: flake8
+        name: flake8
+        entry: python -m flake8 
+        language: system
+        types: [python]
+        exclude: 'examples'
+    -   id: black
+        name: black
+        entry: python -m black --check
+        language: system
+        types: [python]
+        exclude: 'examples|docs'

.readthedocs.yml

@@ -0,0 +1,28 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# # Include PDF and ePub
+# formats: all
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "mambaforge-4.10"
+
+conda:
+  environment: environment.yml
+
+python:
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs

.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.formatOnType": true
+    },
+    "python.formatting.provider": "black",
+    "python.formatting.blackArgs": [
+        "--config",
+        "pyproject.toml"],
+    "python.linting.enabled": true,
+    "python.linting.flake8Enabled": true,
+    "python.linting.flake8Args": [
+        "--config=setup.cfg"
+    ],
+    "flake8.args": [
+        "--config=setup.cfg"
+    ],
+    "autoDocstring.docstringFormat": "numpy",
+    "autoDocstring.startOnNewLine": true,
+    "python.pythonPath": "myenv/bin/python3",
+}