Merge pull request #38 from sbillinge/ci

ci

.flake8

@@ -4,9 +4,9 @@ exclude =
     __pycache__,
     build,
     dist,
-    versioneer.py,
-    labpdfproc/_version.py,
-    doc/manual/source/conf.py
+    doc/source/conf.py,
+    */doc/source/conf.py
+builtins = cookiecutter
 max-line-length = 115
 # Ignore some style 'errors' produced while formatting by 'black' (see link below)
 # https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings

.pre-commit-config.yaml

@@ -21,6 +21,7 @@ repos:
     rev: 24.4.2
     hooks:
       - id: black
+        exclude: ./doc/source/conf\.py
   - repo: https://github.com/pycqa/flake8
     rev: 7.0.0
     hooks:

doc/source/conf.py

@@ -20,6 +20,8 @@
 import os
 import sys
 
+import sphinx_rtd_theme
+
 sys.path.insert(0, os.path.abspath("vendor"))
 
 
@@ -107,7 +109,6 @@
 # a list of builtin themes.
 #
 html_theme = "sphinx_rtd_theme"
-import sphinx_rtd_theme
 
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 

doc/source/vendor/youtube.py

@@ -17,7 +17,7 @@
 def get_size(d, key):
     if key not in d:
         return None
-    m = re.match("(\d+)(|%|px)$", d[key])
+    m = re.match(r"(\d+)(|%|px)$", d[key])
     if not m:
         raise ValueError("invalid size %r" % d[key])
     return int(m.group(1)), m.group(2) or "px"
@@ -88,8 +88,7 @@ def depart_youtube_node(self, node):
 
 def visit_youtube_node_latex(self, node):
     self.body.append(
-        r"\begin{quote}\begin{center}\fbox{\url{https://www.youtu.be/%s}}\end{center}\end{quote}"
-        % node["id"]
+        r"\begin{quote}\begin{center}\fbox{\url{https://www.youtu.be/%s}}\end{center}\end{quote}" % node["id"]
     )
 
 
@@ -107,17 +106,15 @@ class YouTube(Directive):
     def run(self):
         if "aspect" in self.options:
             aspect = self.options.get("aspect")
-            m = re.match("(\d+):(\d+)", aspect)
+            m = re.match(r"(\d+):(\d+)", aspect)
             if m is None:
                 raise ValueError("invalid aspect ratio %r" % aspect)
             aspect = tuple(int(x) for x in m.groups())
         else:
             aspect = None
         width = get_size(self.options, "width")
         height = get_size(self.options, "height")
-        return [
-            youtube(id=self.arguments[0], aspect=aspect, width=width, height=height)
-        ]
+        return [youtube(id=self.arguments[0], aspect=aspect, width=width, height=height)]
 
 
 def unsupported_visit_youtube(self, node):

pyproject.toml

@@ -0,0 +1,20 @@
+[tool.black]
+line-length = 115
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build/
+  | buck-out
+  | build
+  | dist
+  | ./doc/source/conf\.py
+  | blib2to3
+  | tests/data/
+  | .*conf\.py$
+)/
+'''

{{ cookiecutter.repo_name }}/setup.py

@@ -34,11 +34,7 @@
 
 with open(path.join(here, "requirements.txt")) as requirements_file:
     # Parse requirements.txt, ignoring any commented-out lines.
-    requirements = [
-        line
-        for line in requirements_file.read().splitlines()
-        if not line.startswith("#")
-    ]
+    requirements = [line for line in requirements_file.read().splitlines() if not line.startswith("#")]
 
 
 setup(

{{ cookiecutter.repo_name }}/src/diffpy/{{ cookiecutter.package_dir_name }}/version.py

@@ -131,10 +131,7 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):
             root = os.path.dirname(root)  # up a level
 
     if verbose:
-        print(
-            "Tried directories %s but none started with prefix %s"
-            % (str(rootdirs), parentdir_prefix)
-        )
+        print("Tried directories %s but none started with prefix %s" % (str(rootdirs), parentdir_prefix))
     raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
 
 
@@ -322,9 +319,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
         pieces["distance"] = int(count_out)  # total number of commits
 
     # commit date: see ISO-8601 comment in git_versions_from_keywords()
-    date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[
-        0
-    ].strip()
+    date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip()
     pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
 
     return pieces