Add Cimpy 3_0

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

.github/workflows/docs.yaml

@@ -0,0 +1,70 @@
+name: Documentation
+
+on:
+  pull_request:
+
+  push:
+    branches:
+      - master
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        shell: bash
+        run: |
+          sudo apt-get -y install graphviz
+
+      - name: Install Python dependencies
+        run: |
+          pip install .[doc]
+
+      - name: Build documentation
+        working-directory: documentation
+        run: |
+          sphinx-apidoc \
+            --full \
+            --doc-project "cimpy" \
+            --separate \
+            --output-dir "." \
+            "../"
+
+          python3 set_inheritance_diagram.py
+
+          make html
+
+          touch _build/html/.nojekyll
+
+          ls -l _build/html
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: documentation/_build/html
+
+      - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/master'
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pre-commit.yaml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/[email protected]

.github/workflows/test.yaml

@@ -0,0 +1,40 @@
+name: Pytest
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        shell: bash
+        run: |
+          sudo apt-get -y install graphviz
+
+      - name: Install Python dependencies
+        run: |
+          pip install .[dev]
+
+      - name: Run pytest
+        run: |
+          pytest -v -cov --junitxml=report.xml
+
+      - name: Upload pytest test results
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: pytest-results
+          path: cimpy/report.xml

.gitignore

@@ -1,17 +1,14 @@
-# python folders
+# Python folders
 *.egg-info/
 __pycache__
 .idea
+.venv
 ./cimpy/__pycache__
 *.egg
 build/
 dist/
 
-# log files
 *.log
 
-# vs code
+# VSCode
 .vscode/*
-
-# documentation
-# documentation/

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+exclude: ^cimpy/cgmes_
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.0
+    hooks:
+      - id: flake8