Initial commit

.coveragerc

@@ -0,0 +1,13 @@
+[run]
+branch = True
+source = robustnessgym
+
+[report]
+exclude_lines =
+    if self.debug:
+    pragma: no cover
+    raise NotImplementedError
+    if __name__ == .__main__.:
+ignore_errors = True
+omit =
+    tests/*

.flake8

@@ -0,0 +1,11 @@
+# This is our code-style check. We currently allow the following exceptions:
+#   - E731: do not assign a lambda expression, use a def
+#   - W503: line break before binary operator
+#   - E741: do not use variables named 'l', 'O', or 'I'
+#   - E203: whitespace before ':'
+[flake8]
+count = True
+max-line-length = 88
+statistics = True
+ignore = E731,W503,E741,E203
+exclude = setup.py

.github/workflows/ci.yml

@@ -0,0 +1,124 @@
+name: CI
+
+on:
+    push:
+        branches: [ master ]
+    pull_request:
+        branches: [ master ]
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+jobs:
+
+    Linting:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ['3.8']
+
+        steps:
+            -   uses: actions/checkout@v2
+            -   name: Set up Python ${{ matrix.python-version }}
+                uses: actions/setup-python@v2
+                with:
+                    python-version: ${{ matrix.python-version }}
+
+            -   uses: actions/cache@v2
+                with:
+                    path: ~/.cache/pip
+                    key: ${{ runner.os }}-pip
+
+            -   name: Install Dependencies
+                run: |
+                    python -m pip install --upgrade pip
+                    make dev
+
+            -   name: Lint with isort, black, docformatter, flake8
+                run: |
+                    make autoformat
+                    make lint
+    
+    Documentation:
+        needs: Linting
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ['3.8']
+
+        steps:
+            -   uses: actions/checkout@v2
+            -   name: Set up Python ${{ matrix.python-version }}
+                uses: actions/setup-python@v2
+                with:
+                    python-version: ${{ matrix.python-version }}
+
+            -   uses: actions/cache@v2
+                with:
+                    path: ~/.cache/pip
+                    key: ${{ runner.os }}-pip
+
+            -   name: Install Dependencies
+                run: |
+                    python -m pip install --upgrade pip
+                    make dev
+    
+            -   name: Generate Docs
+                run: |
+                    make docs
+
+    Build:
+        needs: Documentation
+        runs-on: ${{ matrix.os }}
+        strategy:
+            matrix:
+                os: [ubuntu-latest] #, macos-latest]
+                python-version: ['3.8']
+
+        steps:
+            -   uses: actions/checkout@v2
+
+            -   name: Set up Python ${{ matrix.python-version }}
+                uses: actions/setup-python@v2
+                with:
+                    python-version: ${{ matrix.python-version }}
+
+            -   name: Install Poetry
+                uses: snok/[email protected]
+                with:
+                    version: 1.1.4
+                    virtualenvs-create: true
+                    virtualenvs-in-project: true
+
+            -   name: Set up Poetry cache for Python dependencies
+                id: cached-poetry-dependencies
+                uses: actions/cache@v2
+                with:
+                    path: .venv
+                    key: poetry-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+
+            -   name: Install Dependencies
+                if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+                run: |
+                    poetry install --no-interaction
+
+            -   name: Test with pytest
+                run: |
+                    source .venv/bin/activate
+                    make test-cov
+            
+            -   name: Upload to codecov.io
+                uses: codecov/codecov-action@v1
+                with:
+                    file: ./coverage.xml
+                    flags: unittests
+                    name: codecov-umbrella
+                    fail_ci_if_error: true
+
+            -   name: Publish distribution 📦 to PyPI
+                if: startsWith(github.event.ref, 'refs/tags')
+                env:
+                    PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+                run: |
+                    poetry config pypi-token.pypi $PYPI_TOKEN
+                    poetry publish --build

.gitignore

@@ -0,0 +1,147 @@
+# Jupyter notebooks
+notebooks/
+
+# Note files
+notes.md
+
+# Mac
+.DS_STORE
+
+# VSCode
+.vscode
+
+# Apache Arrow
+*.arrow
+
+# Pycharm
+.idea
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.isort.cfg

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

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/timothycrosley/isort
+    rev: 5.7.0
+    hooks:
+    -   id: isort
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    - id: black
+      language_version: python3
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+    -   id: flake8

.readthedocs.yml

@@ -0,0 +1,22 @@
+# .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/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+  system_packages: true