Cleanup repo + prepare precommit

Author: cphyc

.github/workflows/pytest.yml

@@ -19,8 +19,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 'pytest~=6.1.1' 'pytest-cov==2.10.1' 'pytest-mpl==0.12'
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f test_requirements.txt ]; then pip install -r test_requirements.txt; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+-   repo: https://github.com/ambv/black
+    rev: 19.10b0
+    hooks:
+    - id: black
+      language_version: python3.7
+-   repo: https://github.com/timothycrosley/isort
+    rev: '5.5.3'
+    hooks:
+    -   id: isort
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: '3.8.1'
+    hooks:
+    -   id: flake8
+-   repo: https://github.com/ikamensh/flynt
+    rev: '0.52'
+    hooks:
+    -   id: flynt

MANIFEST.in

@@ -0,0 +1 @@
+include Readme.md LICENSE

dev_requirements.txt

@@ -0,0 +1,6 @@
+flake8==3.8.3
+flake8-black==0.2.1
+flake8-bugbear==20.11.1
+pytest~=6.1.1
+pytest-cov==2.10.1
+pytest-mpl==0.12

labellines/core.py

@@ -2,7 +2,6 @@
 from datetime import datetime
 from math import atan2, degrees
 
-import matplotlib.pyplot as plt
 import numpy as np
 from matplotlib.container import ErrorbarContainer
 from matplotlib.dates import DateConverter, date2num, num2date
@@ -21,8 +20,8 @@ def labelLine(line, x, label=None, align=True, drop_label=False, **kwargs):
     label : string, optional
        The label to set. This is inferred from the line by default
     drop_label : bool, optional
-       If True, the label is consumed by the function so that subsequent calls to e.g. legend
-       do not use it anymore.
+       If True, the label is consumed by the function so that subsequent
+       calls to e.g. legend do not use it anymore.
     kwargs : dict, optional
        Optional arguments passed to ax.text
     """
@@ -40,8 +39,9 @@ def labelLine(line, x, label=None, align=True, drop_label=False, **kwargs):
         xa = min(xdata)
         xb = max(xdata)
     else:
-        for i, (xa, xb) in enumerate(zip(xdata[:-1], xdata[1:])):
+        for imatch, (xa, xb) in enumerate(zip(xdata[:-1], xdata[1:])):
             if min(xa, xb) <= x <= max(xa, xb):
+                i = imatch
                 break
         else:
             raise Exception("x label location is outside data range!")
@@ -126,8 +126,8 @@ def labelLines(
        The location of the labels. If a tuple, the labels will be
        evenly spaced between xfirst and xlast (in the axis units).
     drop_label : bool, optional
-       If True, the label is consumed by the function so that subsequent calls to e.g. legend
-       do not use it anymore.
+       If True, the label is consumed by the function so that subsequent
+       calls to e.g. legend do not use it anymore.
     shrink_factor : double, optional
        Relative distance from the edges to place closest labels. Defaults to 0.05.
     kwargs : dict, optional

pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+# See https://github.com/scipy/scipy/pull/10431 for the AIX issue.
+requires = [
+  "setuptools>=19.6",
+  "wheel"
+]
+
+# To be kept consistent with "Code Style" section in CONTRIBUTING.rst
+[tool.black]
+line-length = 88
+target-version = ['py36', 'py37', 'py38']
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+
+# To be kept consistent with "Import Formatting" section in CONTRIBUTING.rst
+[tool.isort]
+profile = "black"
+combine_as_imports = true
+skip =  []
+known_third_party = [
+  "IPython",
+  "nose",
+  "numpy",
+  "sympy",
+  "matplotlib",
+  "git",
+  "yaml",
+  "dateutil",
+  "requests",
+  "coverage",
+  "pytest",
+  "pyx",
+]
+known_first_party = ["labellines"]
+sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]

setup.cfg

@@ -0,0 +1,35 @@
+[egg_info]
+#tag_build = .dev
+#tag_svn_revision = 1
+
+[flake8]
+# Copied from the yt-project
+max-line-length=88
+exclude = doc,
+          benchmarks,
+          */api.py,                          # avoid spurious "unused import"
+          yt/convenience.py,                 # avoid spurious "unused import"
+          */__init__.py,                     # avoid spurious "unused import"
+          */__config__.py,                   # autogenerated
+          yt/extern,                         # vendored libraries
+          yt/units,                          # wrapper around unyt, avoid spurious "unused import"
+          yt/frontends/stream/sample_data,   # autogenerated
+
+          # individual files
+          yt/visualization/_mpl_imports.py,
+          yt/utilities/fits_image.py,
+          yt/utilities/lodgeit.py,
+          yt/mods.py,
+          yt/visualization/_colormap_data.py,
+
+ignore = E203, # Whitespace before ':' (black compatibility)
+         E231, # Missing whitespace after ',', ';', or ':'
+         E266, # Too many leading '#' for block comment
+         E302, # Expected 2 blank lines, found 0
+         E306, # Expected 1 blank line before a nested definition
+         E741, # Do not use variables named 'I', 'O', or 'l'
+         W503, # Line break occurred before a binary operator (black compatibility)
+         W605, # Invalid escape sequence 'x'
+         B302, # this is a python 3 compatibility warning, not relevant since don't support python 2 anymore
+
+jobs=8

setup.py

@@ -1,27 +1,24 @@
 # -*- coding: utf-8 -*-
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
-with open('Readme.md') as file:
+with open("Readme.md") as file:
     long_description = file.read()
 
-with open('LICENSE') as f:
+with open("LICENSE") as f:
     license = f.read()
 
 setup(
-    name='matplotlib-label-lines',
-    version='0.3.8',
-    description='Label lines in matplotlib.',
-    long_description = long_description,
-    long_description_content_type='text/markdown',
-    author='Corentin Cadiou',
-    author_email='[email protected]',
-    url='https://github.com/cphyc/matplotlib-label-lines',
-    license='MIT',
-    packages=find_packages(exclude=('tests', 'docs')),
-    install_requires=[
-        'numpy',
-        'matplotlib'
-    ],
-    include_package_data=True
+    name="matplotlib-label-lines",
+    version="0.3.8",
+    description="Label lines in matplotlib.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="Corentin Cadiou",
+    author_email="[email protected]",
+    url="https://github.com/cphyc/matplotlib-label-lines",
+    license="MIT",
+    packages=find_packages(exclude=("tests", "docs")),
+    install_requires=["numpy", "matplotlib"],
+    include_package_data=True,
 )