Merge pull request #18 from developmentseed/updateCiAndPre-Commit

update CI and pre-commit, add setup.cfg for lint configs

Author: vincentsarago

.github/workflows/ci.yml

@@ -7,29 +7,29 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     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 dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install tox codecov pre-commit
-      
+
       # Run tox using the version of Python in `PATH`
       - name: Run Tox
         run: tox -e py
-      
+
       # Run pre-commit (only for python-3.7)
       - name: run pre-commit
         if: matrix.python-version == 3.7
         run: pre-commit run --all-files
-      
+
       - name: Upload Results
         if: success()
         uses: codecov/codecov-action@v1
@@ -48,13 +48,13 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
-          python-version: "3.x" 
-     
+          python-version: "3.x"
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install tox
-      
+
       - name: Set tag version
         id: tag
         # https://stackoverflow.com/questions/58177786/get-the-current-pushed-tag-in-github-actions
@@ -64,7 +64,7 @@ jobs:
         id: module
         # https://stackoverflow.com/questions/58177786/get-the-current-pushed-tag-in-github-actions
         run: echo ::set-output name=version::$(python setup.py --version)
-      
+
       - name: Build and publish
         if: steps.tag.outputs.tag == steps.module.outputs.version
         env:

.gitignore

@@ -1,10 +1,103 @@
-*.pyc
-*~
-*.egg-info
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
 build/
+develop-eggs/
 dist/
-*.eggs
-MANIFEST
-.DS_Store
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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.*
 .cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.pytest_cache

.pre-commit-config.yaml

@@ -1,45 +1,48 @@
 repos:
-    -   
-        repo: https://github.com/pre-commit/mirrors-isort
-        rev: v4.3.21
-        hooks:
-            - id: isort
-              language_version: python3.7
-    -
-        repo: 'https://github.com/psf/black'
-        rev: stable
-        hooks:
-            - id: black
-              args: ['--safe']
-              language_version: python3.7
-    -
-        repo: https://gitlab.com/PyCQA/flake8
-        rev: 3.8.3
-        hooks:
-            - id: flake8
-              language_version: python3.7
-              args: [
-                  # E501 let black handle all line length decisions
-                  # W503 black conflicts with "line break before operator" rule
-                  # E203 black conflicts with "whitespace before ':'" rule
-                  '--ignore=E501,W503,E203']
-    -
-        repo: 'https://github.com/chewse/pre-commit-mirrors-pydocstyle'
-        # 2.1.1
-        rev: 22d3ccf6cf91ffce3b16caa946c155778f0cb20f
-        hooks:
-            - id: pydocstyle
-              language_version: python3.7
-              args: [
-                 # Check for docstring presence only
-                 '--select=D1',
-                 # Don't require docstrings for tests
-                 '--match=(?!test).*\.py']
+  - repo: https://github.com/psf/black
+    rev: 19.10b0
+    hooks:
+      - id: black
+        language_version: python
 
-    -   
-        repo: https://github.com/pre-commit/mirrors-mypy
-        rev: 'v0.782'
-        hooks:
-            -   id: mypy
-                exclude: ^python_seed/template
-                args: [--no-strict-optional, --ignore-missing-imports]
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.4.2
+    hooks:
+      - id: isort
+        language_version: python
+        args: [
+            '--project=python_seed',
+            '--thirdparty=click',
+            '--section-default=THIRDPARTY']
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 3.8.3
+    hooks:
+      - id: flake8
+        language_version: python
+        args: [
+            # E501 let black handle all line length decisions
+            # W503 black conflicts with "line break before operator" rule
+            # E203 black conflicts with "whitespace before ':'" rule
+            '--ignore=E501,W503,E203',
+            '--max-complexity=12',
+            '--max-line-length=90']
+
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 5.1.1
+    hooks:
+      - id: pydocstyle
+        language_version: python
+        args: [
+            # Check for docstring presence only
+            '--select=D1',
+            # Don't require docstrings for tests
+            '--match=(?!test).*\.py']
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.812
+    hooks:
+      - id: mypy
+        language_version: python
+        exclude: ^python_seed/template
+        args: [--no-strict-optional, --ignore-missing-imports]

CHANGES.txt

@@ -1,5 +1,12 @@
+1.1.0 (2021-05-07)
+------------------
+- update pre-commit config
+- add python3.9 in CI
+- add `setup.cfg` for linters
+- remove `pkg_resources` usage
+
 1.0.1 (2020-08-27)
-------------------------
+------------------
 - add coverage.xml output from tox runs.
 
 1.0.0.post2 (2020-08-21)

python_seed/__init__.py

@@ -1,5 +1,3 @@
 """python_seed."""
 
-import pkg_resources
-
-version = pkg_resources.get_distribution(__package__).version
+__version__ = "1.0.1"

python_seed/scripts/cli.py

@@ -4,13 +4,18 @@
 import shutil
 
 import click
-import pkg_resources
 
-from .. import version
+from .. import __version__
+
+try:
+    from importlib.resources import files as resources_files  # type: ignore
+except ImportError:
+    # Try backported to PY<39 `importlib_resources`.
+    from importlib_resources import files as resources_files  # type: ignore
 
 
 @click.group(short_help="python-seed CLI")
-@click.version_option(version=version, message="%(version)s")
+@click.version_option(version=__version__, message="%(version)s")
 def pyseed():
     """python-seed subcommands."""
     pass
@@ -23,18 +28,18 @@ def pyseed():
 )
 def create(name, ci):
     """Create new python seed skeleton."""
-    template_dir = pkg_resources.resource_filename("python_seed", "template/module")
-
+    template_dir = str(resources_files("python_seed") / "template" / "module")
+    print(template_dir)
     shutil.copytree(template_dir, name)
 
     if ci:
-        template_dir = pkg_resources.resource_filename(
-            "python_seed", f"template/ci/.{ci}"
+        template_dir = str(
+            resources_files("python_seed") / "template" / "ci" / f".{ci}"
         )
         shutil.copytree(template_dir, f"{name}/.{ci}")
 
-        covconfig = pkg_resources.resource_filename(
-            "python_seed", "template/cov/codecov.yml"
+        covconfig = str(
+            resources_files("python_seed") / "template" / "cov" / "codecov.yml"
         )
         shutil.copy2(covconfig, f"{name}/codecov.yml")
 

python_seed/template/ci/.circleci/config.yml

@@ -46,28 +46,35 @@ jobs:
   "python-3.6":
     <<: *common
     docker:
-      - image: circleci/python:3.6.5
+      - image: cimg/python:3.6.13
         environment:
           - TOXENV=py36
 
   "python-3.7":
     <<: *common
     docker:
-      - image: circleci/python:3.7.2
+      - image: cimg/python:3.7.10
         environment:
           - TOXENV=py37
           - UPLOAD_COVERAGE=1
 
   "python-3.8":
     <<: *common
     docker:
-      - image: circleci/python:3.8.4
+      - image: cimg/python:3.8.10
         environment:
           - TOXENV=py38
 
+  "python-3.9":
+    <<: *common
+    docker:
+      - image: cimg/python:3.9.5
+        environment:
+          - TOXENV=py39
+
   deploy:
       docker:
-        - image: circleci/python:3.7.2
+        - image: cimg/python:3.7.10
           environment:
             - TOXENV=release
       working_directory: ~/pyseed
@@ -99,6 +106,7 @@ workflows:
             tags:
               only: /.*/
       - "python-3.8"
+      - "python-3.9"
       - deploy:
           requires:
             - "python-3.7"