Merge pull request #21 from tpvasconcelos/feat/docs

Upgrade project structure

.editorconfig

@@ -13,8 +13,6 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.py]
-# docstrings and comments use max_line_length = 80
-# import statements use max_line_length = 100
 max_line_length=120
 
 # 2 space indentation

.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @tpvasconcelos

.github/actions/setup-python/action.yml

@@ -0,0 +1,30 @@
+name: Setup python
+
+description: Setup python and install dependencies
+
+inputs:
+  python-version:
+    description: "Python version"
+    required: false
+    default: "3.9"
+  requirements-path:
+    description: "Path to requirements.txt file"
+    required: false
+    default: "requirements/ci.txt"
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-python@v3
+      with:
+        python-version: "${{ inputs.python-version }}"
+        cache: pip
+        cache-dependency-path: "${{ inputs.requirements-path }}"
+
+    - name: Ensure pip, setuptools, and wheel are up to date
+      shell: bash
+      run: python -m pip install --upgrade pip setuptools wheel
+
+    - name: Install requirements
+      shell: bash
+      run: python -m pip install -r "${{ inputs.requirements-path }}"

.github/workflows/check_release_notes.yaml → .github/workflows/check-release-notes.yaml

@@ -8,10 +8,8 @@ jobs:
   build:
     name: Check for entry in CHANGES.md
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v3
       - name: Grep CHANGES.md for PR number
         if: contains(github.event.pull_request.labels.*.name, 'skip news') != true
         run: |

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  ci-checks:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version:
+          - "3.7"
+          - "3.8"
+          - "3.9"
+          - "3.10"
+        os:
+          - "ubuntu-latest"
+          - "macos-latest"
+          - "windows-latest"
+      fail-fast: true
+    env:
+      OS: "${{ matrix.os }}"
+      PYTHON: "${{ matrix.python-version }}"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-python
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - name: Run CI checks with Tox
+        run: tox
+      - name: Upload coverage to codecov
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          env_vars: OS,PYTHON
+          fail_ci_if_error: true
+          verbose: true
+      - name: Upload coverage to codacy
+        uses: codacy/codacy-coverage-reporter-action@v1
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: coverage.xml

.github/workflows/publish-pypi.yaml

@@ -0,0 +1,24 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  build-and-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-python
+        with:
+          python-version: "3.7"
+      - name: Package and upload a release to test pypi
+        env:
+          TWINE_PASSWORD: "${{ secrets.PYPI_TOKEN_TEST }}"
+        run: tox -e build,release-test
+      - name: Package and upload a release prod pypi
+        env:
+          TWINE_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
+        run: tox -e build,release-prod

.gitignore

@@ -5,18 +5,14 @@
 # add custom entries here...
 
 
-# PyCharm  ---
-# exclude everything under
-.idea/*
-# except for...
-!.idea/ridgeplot.iml
-
-
 # ============================================================================
 #  My custom additions missing from
 #  https://github.com/github/gitignore (see bellow)
 # ============================================================================
 
+# PyCharm  ---
+.idea/
+
 # celery  ---
 **/celery*.log
 **/celery*.pid

.pre-commit-config.yaml

@@ -1,9 +1,9 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.3.0
     hooks:
       - id: check-added-large-files
-        args: ['--maxkb=500']
+        args: [ '--maxkb=500' ]
       - id: check-ast
       - id: check-builtin-literals
       - id: check-case-conflict
@@ -22,45 +22,55 @@ repos:
       - id: end-of-file-fixer
       - id: fix-byte-order-marker
       - id: mixed-line-ending
-      - id: name-tests-test
-        args: ['--django']
       - id: pretty-format-json
-        args: ['--autofix']
+        args: [ '--autofix' ]
       - id: trailing-whitespace
         exclude: .bumpversion.cfg
 
+  - repo: https://github.com/mgedmin/check-manifest
+    rev: "0.48"
+    hooks:
+      - id: check-manifest
+        args: [ --no-build-isolation ]
+
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.10.0
+    rev: v2.34.0
     hooks:
       - id: pyupgrade
-        args: [ --py36-plus, --keep-runtime-typing]
+        args: [ --py36-plus, --keep-runtime-typing ]
         description: Automatically upgrade syntax for newer versions of the python language.
 
-  - repo: https://github.com/psf/black
-    rev: 20.8b1
+  - repo: local
     hooks:
+
+      - id: pip-compile-multi-verify
+        name: pip-compile-multi verify
+        language: python
+        entry: pip-compile-multi verify
+        files: ^requirements/
+        pass_filenames: false
+        require_serial: true
+        types: [ file, non-executable, text ]
+
       - id: black
+        name: black
+        entry: black
+        language: python
+        require_serial: true
+        types_or: [ python, pyi, jupyter ]
 
-  - repo: https://github.com/pycqa/isort
-    rev: 5.7.0
-    hooks:
       - id: isort
-        name: isort (python)
-      - id: isort
-        name: isort (cython)
-        types: [cython]
-      - id: isort
-        name: isort (pyi)
-        types: [pyi]
+        name: isort
+        entry: isort
+        args: [ '--filter-files' ]
+        require_serial: true
+        language: python
+        language_version: python3
+        types_or: [ cython, pyi, python ]
 
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
-    hooks:
       - id: flake8
-        additional_dependencies: [flake8-typing-imports==1.7.0]
-
-  # - repo: https://github.com/pre-commit/mirrors-mypy
-  #   rev: v0.812
-  #   hooks:
-  #     - id: mypy
-  #       pass_filenames: false
+        name: flake8
+        entry: flake8
+        language: python
+        types: [ python ]
+        require_serial: true