CI updates (#44)

* Split into compabitibility vs unit tests

* Update the python versions we test on

* .gitignore updates

* include a MANIFEST.in

* Use a valid unreleased semvar in VERSION

* Switch to pyproject.toml

* Use pre-commit for CI checks

* Fix isort issues

* Update coverage, build badges

* Add black to the CI

* Add coverage, macOS files to gitignore

* VERSION file must be specified in a list

* Use checkout@v3 for all test runs

* Extra black exceptions

Author: AnjoMan

.github/workflows/python-package.yaml

@@ -12,29 +12,58 @@ on:
       - master
 
 jobs:
-  test:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test]
+        pre-commit install
+        pre-commit autoupdate
+    - name: Lint with precommit checks
+      run: |
+        pre-commit run --all-files
+    - name: Test with Pytest
+      run: |
+        pytest \
+          --junitxml=junit/test-results.xml \
+          --cov-report=xml --cov=carsons \
+          tests/
+    - name: Make coverage file
+      run: |
+        coverage xml
+    - uses: codecov/codecov-action@v3
+      with:
+        files: ./coverage.xml # optional
+        flags: unittests # optional
+        name: codecov-umbrella # optional
+        fail_ci_if_error: true # optional (default = false)
+        verbose: true # optional (default = false)
+
+  compatibility:
+    needs: unit-test
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.7", "3.8", "3.9", "3.11", pypy3.8, pypy3.9]
+        # skipping 3.10 since the unit-test job runs against it
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -e .[test]
-    - name: Lint with flake8
-      run: |
-        flake8
     - name: Test with Pytest
       run: |
-        pytest \
-          --junitxml=junit/test-results.xml \
-          --mypy \
-          --cov-report term-missing  --cov-report=xml --cov-report=html --cov=carsons \
-          tests/
+        pytest

.github/workflows/python-publish.yaml

@@ -19,9 +19,9 @@ jobs:
       VERSION_FILE: $(basename $GITHUB_REPOSITORY)/VERSION
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies

.gitignore

@@ -3,4 +3,15 @@
 */__pycache__/
 
 .coverage
+.coverage.xml
+
+# IDE stuff
 carsons.code-workspace
+.DS_store
+
+# pyenv
+.python-version
+
+# build
+dist
+*.egg-info

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+# pre-commit runs static analysis in the CI for this repo
+#
+# you can also use it to have the static analysis run incrementally on your commits;
+#
+# install:
+#
+#     pip install .[test]
+#     pre-commit install
+#
+# after this, pre-commit will run automatically when you run `git commit`; it will
+# flag any answers, and in the case of black / isort will automatically update
+# your local files
+#
+# run on the whole repo: pre-commit run --all-files
+# run a single hook:     pre-commit run --all-files black
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    - id: mixed-line-ending
+      args: ['--fix=lf']
+      description: Forces to replace line ending by the UNIX 'lf' character.
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        name: Flake PEP8 check
+        additional_dependencies: ["importlib-metadata<=4.13.0"]
+        args: ["--max-line-length=120"]
+
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+        name: Black autoformatting
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.11.4
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v0.991"
+    hooks:
+      - id: mypy

MANIFEST.in

@@ -0,0 +1,4 @@
+include carsons/VERSION
+include carsons/py.typed
+
+prune tests

README.md

@@ -4,7 +4,7 @@ carsons
 [![latest release on pypi](https://badge.fury.io/py/carsons.svg)](https://badge.fury.io/py/carsons)
 [![versons of python supported by carsons](https://img.shields.io/pypi/pyversions/carsons.svg)](https://pypi.python.org/pypi/carsons)
 [![GitHub license](https://img.shields.io/github/license/opusonesolutions/carsons.svg)](https://github.com/opusonesolutions/carsons/blob/master/LICENSE.txt)
-[![build passing or failing](https://travis-ci.org/opusonesolutions/carsons.svg?branch=master)](https://travis-ci.org/opusonesolutions/carsons)
+[![build passing or failing](https://github.com/opusonesolutions/carsons/blob/master/.github/workflows/python-package.yaml/badge.svg)](https://travis-ci.org/opusonesolutions/carsons)
 [![test coverage](https://coveralls.io/repos/github/opusonesolutions/carsons/badge.svg?branch=master)](https://coveralls.io/github/opusonesolutions/carsons?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/22cfed180fd6032fe29b/maintainability)](https://codeclimate.com/github/opusonesolutions/carsons/maintainability)
 

carsons/VERSION

@@ -1 +1 @@
-unreleased
+99999999999.0.0.dev0+unreleased

carsons/__init__.py

@@ -1,10 +1,30 @@
-from carsons.carsons import (convert_geometric_model,               # noqa 401
-                             calculate_impedance,                   # noqa 401
-                             calculate_sequence_impedance_matrix,
-                             calculate_sequence_impedances,
-                             CarsonsEquations,
-                             ConcentricNeutralCarsonsEquations,     # noqa 401
-                             MultiConductorCarsonsEquations,        # noqa 401
-                             TapeShieldedCableCarsonsEquations)        # noqa 401
+from carsons.carsons import (  # noqa F401
+    CarsonsEquations,
+    ConcentricNeutralCarsonsEquations,
+    MultiConductorCarsonsEquations,
+    TapeShieldedCableCarsonsEquations,
+    calculate_impedance,
+    calculate_sequence_impedance_matrix,
+    calculate_sequence_impedances,
+    convert_geometric_model,
+)
 
 name = "carsons"
+
+
+def get_version():
+    import sys
+
+    # TODO: if 3.8 support is dropped, we can standardize on
+    # importlib.resources.files
+    if sys.version_info < (3, 9):
+        from importlib.resources import read_text
+
+        return read_text(__name__, "VERSION").strip()
+    else:
+        from importlib.resources import files
+
+        return files(__name__).joinpath("VERSION").open("r").read().strip()
+
+
+__version__ = get_version()