Merge pull request #258 from python/feature/skeleton

Adopt practices from jaraco/skeleton. Fixes #255

Author: jaraco

.coveragerc

@@ -0,0 +1,8 @@
+[run]
+omit =
+    */.tox/*
+    tests/*
+    prepare/*
+
+[report]
+show_missing = True

.flake8

@@ -0,0 +1,10 @@
+[flake8]
+max-line-length = 88
+ignore =
+	# W503 violates spec https://github.com/PyCQA/pycodestyle/issues/513
+	W503
+	# W504 has issues https://github.com/OCA/maintainer-quality-tools/issues/545
+	W504
+	# Black creates whitespace before colon
+	E203
+enable-extensions = U4

.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python: [3.6, 3.7, 3.8, 3.9]
+        python: [3.6, 3.8, 3.9]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
@@ -20,40 +20,6 @@ jobs:
           python -m pip install tox
       - name: Run tests
         run: tox
-        env:
-          TOXENV: python
-
-  qa:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Install tox
-        run: |
-          python -m pip install tox
-      - name: Run checks
-        run: tox
-        env:
-          TOXENV: qa
-
-  coverage:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Install tox
-        run: |
-          python -m pip install tox
-      - name: Evaluate coverage
-        run: tox
-        env:
-          TOXENV: cov
 
   benchmark:
     runs-on: ubuntu-latest
@@ -89,22 +55,6 @@ jobs:
         env:
           TOXENV: diffcov
 
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Install tox
-        run: |
-          python -m pip install tox
-      - name: Build docs
-        run: tox
-        env:
-          TOXENV: docs
-
   release:
     needs: test
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: stable
+  hooks:
+  - id: black
+
+- repo: https://github.com/asottile/blacken-docs
+  rev: v1.8.0
+  hooks:
+  - id: blacken-docs

.readthedocs.yml

@@ -1,5 +1,6 @@
+version: 2
 python:
-  version: 3
-  extra_requirements:
-    - docs
-  pip_install: true
+  install:
+  - path: .
+    extra_requirements:
+      - docs

docs/changelog.rst renamed to CHANGES.rst

@@ -1,7 +1,3 @@
-=========================
- importlib_metadata NEWS
-=========================
-
 v3.1.0
 ======
 

MANIFEST.in

@@ -1,6 +1,22 @@
-=========================
- ``importlib_metadata``
-=========================
+.. image:: https://img.shields.io/pypi/v/importlib_metadata.svg
+   :target: `PyPI link`_
+
+.. image:: https://img.shields.io/pypi/pyversions/importlib_metadata.svg
+   :target: `PyPI link`_
+
+.. _PyPI link: https://pypi.org/project/importlib_metadata
+
+.. image:: https://github.com/python/importlib_metadata/workflows/Automated%20Tests/badge.svg
+   :target: https://github.com/python/importlib_metadata/actions?query=workflow%3A%22Automated+Tests%22
+   :alt: Automated Tests
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+   :alt: Code style: Black
+
+.. image:: https://readthedocs.org/projects/importlib-metadata/badge/?version=latest
+   :target: https://importlib-metadata.readthedocs.io/en/latest/?badge=latest
+
 
 ``importlib_metadata`` is a library to access the metadata for a
 Python package.

README.rst

@@ -0,0 +1,4 @@
+collect_ignore = [
+    # this module fails mypy tests because 'setup.py' matches './setup.py'
+    'prepare/example/setup.py',
+]