Library (#1)

* first commit

* base method

* cleanup

* add tests

* add depends

* workflows

* add depends

* add diagram

.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: Package release
+
+on:
+  release:
+    types: [created]
+
+
+jobs:
+  deploy_osx:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        os: [macos-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: ${GITHUB_WORKSPACE}/.github/workflows/scripts/release_osx.sh
+
+  deploy_linux:
+    strategy:
+      matrix:
+        python-version:
+          - cp37-cp37m
+          - cp38-cp38
+          - cp39-cp39
+          - cp10-cp10
+
+    runs-on: ubuntu-latest
+    container: quay.io/pypa/manylinux2014_x86_64
+    steps:
+      - uses: actions/checkout@v1
+        with:
+          submodules: true
+      - name: Set target Python version PATH
+        run: |
+            echo "/opt/python/${{ matrix.python-version }}/bin" >> $GITHUB_PATH
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: ${GITHUB_WORKSPACE}/.github/workflows/scripts/release_linux.sh
+
+  deploy_windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          ../../.github/workflows/scripts/release_windows.bat

.github/workflows/scripts/release_linux.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+yum makecache -y
+yum install centos-release-scl -y
+yum-config-manager --enable rhel-server-rhscl-7-rpms
+yum install llvm-toolset-7.0 python3 python3-devel -y
+
+# Python
+python3 -m pip install --upgrade pip
+python3 -m pip install setuptools wheel twine auditwheel
+
+# Publish
+python3 -m pip wheel . -w dist/ --no-deps
+twine upload --verbose --skip-existing dist/*

.github/workflows/scripts/release_osx.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+export MACOSX_DEPLOYMENT_TARGET=10.14
+
+python -m pip install --upgrade pip
+pip install setuptools wheel twine auditwheel
+
+python3 setup.py build bdist_wheel --plat-name macosx_10_14_x86_64 --dist-dir wheel
+twine upload --skip-existing wheel/*

.github/workflows/scripts/release_windows.bat

@@ -0,0 +1,7 @@
+echo on
+
+python -m pip install --upgrade pip
+pip install setuptools wheel twine auditwheel
+
+pip wheel . -w wheel/ --no-deps
+twine upload --skip-existing wheel/*

.github/workflows/test.yml

@@ -0,0 +1,58 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, release]
+  pull_request:
+    types: [opened, synchronize, reopened]
+  schedule:
+    - cron:  '0 0 * * 0'
+
+
+jobs:
+  Linter:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.8]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install .[testing]
+      - name: pre-commit validation
+        run: pre-commit run --files src/*
+      - name: Security checks
+        run: |
+            bandit -r src/*
+
+  Library:
+    needs: [Linter]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', "3.10"]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install MacOS dependencies
+        run: |
+            brew install libomp
+        if: ${{ matrix.os == 'macos-latest' }}
+      - name: Install dependencies
+        run: |
+            pip install .[testing]
+      - name: Test with pytest
+        run: pytest -vvvsx -m "not slow"

.isort.cfg

@@ -0,0 +1,7 @@
+[settings]
+profile = black
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+line_length = 88

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+exclude: 'setup.py|^docs|^experiments|^tests'
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.4.0
+  hooks:
+  - id: trailing-whitespace
+  - id: check-added-large-files
+  - id: check-ast
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-xml
+  - id: check-yaml
+  - id: debug-statements
+  - id: check-executables-have-shebangs
+  - id: end-of-file-fixer
+  - id: requirements-txt-fixer
+  - id: mixed-line-ending
+    args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.8.0
+  hooks:
+  - id: isort
+
+- repo: https://github.com/psf/black
+  rev: 22.3.0
+  hooks:
+  - id: black
+    language_version: python3
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.9.1
+  hooks:
+  - id: flake8
+    args: [
+        "--max-line-length=400",
+        "--extend-ignore=E203,W503"
+    ]
+- repo: local
+  hooks:
+  - id: flynt
+    name: flynt
+    entry: flynt
+    args: [--fail-on-change]
+    types: [python]
+    language: python
+    additional_dependencies:
+        - flynt

docs/Makefile

@@ -0,0 +1,29 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+AUTODOCDIR    = api
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1)
+$(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from https://sphinx-doc.org/")
+endif
+
+.PHONY: help clean Makefile
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf $(BUILDDIR)/* $(AUTODOCDIR)
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/.gitignore

@@ -0,0 +1 @@
+# Empty directory

docs/authors.rst

@@ -0,0 +1,2 @@
+.. _authors:
+.. include:: ../AUTHORS.rst

docs/changelog.rst

@@ -0,0 +1,2 @@
+.. _changes:
+.. include:: ../CHANGELOG.rst