Feat: create project skeleton using CANDI POC experimental api

Signed-off-by: EstherLerouzic <[email protected]>

.github/workflows/main.yml

@@ -0,0 +1,103 @@
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+
+name: CI
+
+jobs:
+  linters:
+    name: Lint Code
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          pip install tox
+      - name: Run linters
+        run: |
+          tox -e linters
+
+  build:
+    name: Tox test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: fedora-python/[email protected]
+        with:
+          tox_env: ${{ matrix.tox_env }}
+          dnf_install: ${{ matrix.dnf_install }}
+      - uses: codecov/[email protected]
+        if: ${{ endswith(matrix.tox_env, '-cover') }}
+        with:
+          files: ${{ github.workspace }}/cover/coverage.xml
+    strategy:
+      fail-fast: false
+      matrix:
+        tox_env:
+          - py38
+          - py39
+          - py310
+          - py311
+          - py312-cover
+        include:
+          - tox_env: docs
+            dnf_install: graphviz
+
+  other-platforms:
+    name: Tests on other platforms
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python_version }}
+      - run: |
+          pip install --editable .[tests]
+          pytest -vv
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-2019
+            python_version: "3.10"
+          - os: windows-2022
+            python_version: "3.11"
+          - os: windows-2022
+            python_version: "3.12"
+          - os: macos-13
+            python_version: "3.12"
+          - os: macos-14
+            python_version: "3.12"
+
+  paywalled-platforms:
+    name: Tests on paywalled platforms
+    if: github.repository_owner == 'Telecominfraproject'
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python_version }}
+      - run: |
+          pip install --editable .[tests]
+          pytest -vv
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: macos-13-xlarge # Apple M1 CPU
+            python_version: "3.12"

README.md

@@ -0,0 +1,37 @@
+# GNPy API
+
+
+REST API (experimental)
+-----------------------
+``gnpyapi`` provides an experimental api for requesting several paths at once. It is based on Flask server.
+You can run it through command line or Docker.
+
+.. code-block:: shell-session
+
+     $ gnpy-rest
+
+.. code-block:: shell-session
+
+    $ docker run -p 8080:8080 -it emmanuelledelfour/gnpy-experimental:candi-1.1 gnpy-rest
+
+When starting the api server will aks for an encryption/decryption key. This key i used to encrypt equipment file when using /api/v1/equipments endpoint.
+This key is a Fernet key and can be generated this way:
+
+.. code-block:: python
+
+from cryptography.fernet import Fernet
+Fernet.generate_key()
+
+
+After typing the key, you can detach the container by typing ^P^Q.
+After starting the api server, you can launch a request
+
+.. code-block:: shell-session
+
+    $ curl -v -X POST -H "Content-Type: application/json" -d @<PATH_TO_JSON_REQUEST_FILE> https://localhost:8080/api/v1/path-computation -k
+
+TODO: api documentation, unit tests, real WSGI server with trusted certificates
+
+## Quick Start
+
+tbd

gnpyapi/core/__init__.py.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+"""GNPy official API
+"""