Merge pull request #1 from ashb/modernize-project

Modernize project: Py3.6+, black, flynt, flake8, Github Actions

Author: ashb

.flake8

@@ -0,0 +1,12 @@
+# -*- cfg -*-
+[flake8]
+format = ${cyan}%(path)s${reset}:${yellow_bold}%(row)d${reset}:${green_bold}%(col)d${reset}: ${red_bold}%(code)s${reset} %(text)s
+exclude = .git, .venv, docs/conf.py
+ignore =
+    E722 ; do not use bare 'except'
+    E741 ; ambiguous variable name
+    W503 ; line break before binary operator -- conflicts with black formatting
+max-complexity = 30
+max-line-length = 160
+show-source = true
+pytest-fixture-no-parentheses = true

.github/workflows/test.yml

@@ -0,0 +1,61 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+
+env:
+  PRE_COMMIT_COLOR: always
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        os: [ubuntu-latest]
+    env:
+      PYTHON: ${{ matrix.python-version }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Cache deps
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cache/pypoetry/
+          ~/.cache/pip/
+        key: python${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
+        restore-keys: python${{ matrix.python-version }}-
+    - name: Cache pre-commit deps
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cache/pre-commit/
+        key: precommit-${{ hashFiles('.pre-commit-config.yaml') }}
+        restore-keys: precommit-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install --upgrade poetry pre-commit
+        poetry install
+    - name: Lint
+      run: |
+        pre-commit run --all-files -v --show-diff-on-failure
+        poetry run pytest --dead-fixtures --dup-fixtures --color=yes
+        pre-commit gc
+    - name: Test with pytest
+      run: |
+        make test args="--color=yes"
+    - name: Upload coverage to Codecov
+      uses: codecov/[email protected]
+      with:
+        flags: unittests
+        env_vars: PYTHON

.pre-commit-config.yaml

@@ -0,0 +1,59 @@
+# To install the git pre-commit hook run:
+#   pre-commit install
+# To update the pre-commit hooks run:
+#   pre-commit install-hooks
+exclude: '^(\.bumpversion\.cfg)(/|$)'
+minimum_pre_commit_version: "1.20.0"
+repos:
+  - repo: meta
+    hooks:
+      - id: identity
+      - id: check-hooks-apply
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      # - id: check-executables-have-shebangs
+      - id: trailing-whitespace
+      - id: fix-encoding-pragma
+        args:
+          - --remove
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.18.1
+    hooks:
+      - id: pyupgrade
+        args: ["--py36-plus"]
+  - repo: https://github.com/ikamensh/flynt/
+    rev: '0.63'
+    hooks:
+    - id: flynt
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        language: system
+        entry: poetry run mypy
+        types: [python]
+        exclude: ^docs/
+      - id: black
+        name: black
+        language: system
+        entry: poetry run black
+        types: [python]
+        exclude: ^docs/conf\.py$
+      - id: flake8
+        name: flake8
+        language: system
+        entry: poetry run flake8
+        types: [python]
+        exclude: ^docs/conf\.py$
+      - id: isort
+        name: isort
+        language: system
+        entry: poetry run isort
+        types: [python]

.travis.yml

@@ -15,20 +15,18 @@ build:  ## Build the sdist/wheel packages
 	poetry build
 
 test:  ## Test the project
-	poetry run pytest --verbosity=2 --strict --log-level=DEBUG $(args)
+	poetry run pytest --verbosity=2 --log-level=DEBUG $(args)
 
 lint:  ## Check code for style
-	poetry run flake8 --statistics --show-source $(CODE) test/
-	poetry run black --diff --check $(CODE) test/
+	pre-commit run
 	poetry run pytest --dead-fixtures --dup-fixtures
 
 pretty: ## Prettify the code
 	poetry run isort $(CODE) test/
 	poetry run black $(CODE) test/
 
 precommit_install: ## Install simple pre-commit checks
-	echo -e '#!/bin/sh\nmake lint test\n' > .git/hooks/pre-commit
-	chmod +x .git/hooks/pre-commit
+	pre-commit install
 
 bump_major: ## Release a new major version
 	poetry version major

Makefile

@@ -1,4 +1,3 @@
-[![Build Status](https://travis-ci.org/ribozz/sphinx-argparse.svg?branch=master)](https://travis-ci.org/ribozz/sphinx-argparse)
 [![Documentation Status](https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable)](http://sphinx-argparse.readthedocs.org/)
 [![PyPI version](https://badge.fury.io/py/sphinx-argparse.svg)](https://badge.fury.io/py/sphinx-argparse)
 [![Install with conda](https://anaconda.org/conda-forge/sphinx-argparse/badges/installer/conda.svg)](https://github.com/conda-forge/sphinx-argparse-feedstock)

README.md

@@ -2,6 +2,11 @@
 Change log
 **********
 
+Unreleased
+##########
+
+ * Minimum python version is now 3.6
+
 0.3.1
 #####
 

docs/changelog.rst

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # sphinx-argparse documentation build configuration file, created by
 # sphinx-quickstart on Thu Jan 31 15:13:43 2013.
@@ -11,7 +10,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
+import sys
 
 # If extensions (or extra_modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -51,8 +51,8 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'sphinx-argparse'
-copyright = u'2017, Alex Rudakov, Devon Ryan and contributors'
+project = 'sphinx-argparse'
+copyright = '2017, Alex Rudakov, Devon Ryan and contributors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -61,6 +61,7 @@
 # The short X.Y version.
 
 import pkg_resources  # part of setuptools
+
 version = pkg_resources.require("sphinx-argparse")[0].version
 
 # The full version, including alpha/beta/rc tags.
@@ -197,8 +198,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'sphinx-argparse.tex', u'sphinx-argparse Documentation',
-   u'Alex Rudakov and Devon Ryan', 'manual'),
+  ('index', 'sphinx-argparse.tex', 'sphinx-argparse Documentation',
+   'Alex Rudakov and Devon Ryan', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -227,8 +228,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'sphinx-argparse', u'sphinx-argparse Documentation',
-     [u'Alex Rudakov', u'Devon Ryan'], 1)
+    ('index', 'sphinx-argparse', 'sphinx-argparse Documentation',
+     ['Alex Rudakov', 'Devon Ryan'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -241,8 +242,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'sphinx-argparse', u'sphinx-argparse Documentation',
-   u'Alex Rudakov and Devon Ryan', 'sphinx-argparse', 'One line description of project.',
+  ('index', 'sphinx-argparse', 'sphinx-argparse Documentation',
+   'Alex Rudakov and Devon Ryan', 'sphinx-argparse', 'One line description of project.',
    'Miscellaneous'),
 ]
 

docs/conf.py

@@ -80,7 +80,7 @@ In addition to using MarkDown in nested content, one can also use MarkDown direc
     def blah():
         parser = argparse.ArgumentParser(description="""
     ### Example of MarkDown inside programs
-    
+
     [I'm a link](http://www.google.com)
     """)
         parser.add_argument('cmd', help='execute a `command`')
@@ -101,4 +101,3 @@ This will then be rendered as:
     :func: blah
     :prog: sample
     :markdownhelp:
-

docs/markdown.rst

@@ -4,7 +4,7 @@ Examples
 Example documentation structure
 -------------------------------
 
-Here is an example structure for the documentation of a complex command with many subcommands. 
+Here is an example structure for the documentation of a complex command with many subcommands.
 You are free to use any structure, but this may be a good starting point.
 
 File "index.rst"::