merge license

.github/workflows/push_doc.yml

@@ -0,0 +1,28 @@
+name: Publish documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - run: pip install .[doc]
+      - name: Sphinx build
+        run: sphinx-build doc build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build

.gitignore

@@ -0,0 +1,90 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+**/.venv/
+poetry.lock
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+**/*.hypothesis/
+
+# DotEnv configuration
+.env
+
+# Documentation builds
+docs/_build
+
+# Data
+**/data/*
+.joblib_cache
+**metastore_db
+
+# Database
+*.db
+*.rdb
+
+# Pycharm
+.idea
+
+# VS Code
+.vscode/
+
+# Spyder
+.spyproject/
+
+# Mac OS-specific storage files
+.DS_Store
+
+# vim
+*.swp
+*.swo
+
+# Mypy cache
+.mypy_cache/
+
+.cache
+
+# Local log files
+.logs/
+# Jupyter
+**/*.ipynb_checkpoints/

.gitlab-ci.yml

@@ -0,0 +1,22 @@
+# The Docker image that will be used to build your app
+image: python:3.8-bullseye
+# Functions that should be executed before the build script is run
+before_script:
+  - pip install -U poetry==1.4.0
+  - poetry install --with docs
+pages:
+  tags:
+    - ci.inria.fr
+    - small
+  script:
+    - make docs-clean
+    - make docs-html
+    - mv docs/_build/html/ public/
+  artifacts:
+    paths:
+      # The folder that contains the files to be exposed at the Page URL
+      - public
+  rules:
+    - changes:
+        - docs/**/*
+        - .gitlab-ci.yml

.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+---
+repos:
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.0
+    hooks:
+      - id: bandit
+        exclude: tests/.*$
+
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        language: system
+        entry: poetry run black
+        types: [python]
+
+  # Docstring coverage tool
+  - repo: https://github.com/econchick/interrogate
+    rev: 1.3.2
+    hooks:
+      - id: interrogate
+        # adjust `fail-under` value as quality standards permit
+        args: [-vv, --fail-under=0]
+
+  - repo: local
+    hooks:
+      - id: isort
+        name: isort
+        language: system
+        entry: poetry run isort
+        types: [python]
+
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.14.0
+    hooks:
+      - id: pyupgrade
+        args: [--py38-plus]
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.26.1
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: check-added-large-files  # Ignored for git-lfs files
+        args: [--maxkb=100000]  # 100MB
+      - id: check-ast
+      - id: end-of-file-fixer  # Ensure files ONLY end in a newline
+        exclude_types: [jupyter]
+      - id: pretty-format-json  # Sort and indent
+        args: [--autofix]
+        exclude: ^(\.cruft\.json)$
+      - id: trailing-whitespace  # Trim
+        args: [--markdown-linebreak-ext=md]

.python-version

@@ -0,0 +1 @@
+3.10

LICENSE

@@ -18,4 +18,8 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+<<<<<<< HEAD
 SOFTWARE.
+=======
+SOFTWARE.
+>>>>>>> cd6d033 (initial github commit)