Add pre-commit support with black and linting with flake8 #77

 - Add .flake8 and .pre-commit-config.yaml
 - Add GitHub actions for linting
 - Blackened tests
 - Add code style badge in README.md
 - Bump version: v0.4.9 -> 0.4.10

Author: astrochun

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+select = E,F,W
+exclude = .git,.idea,.*egg-info,*data,build,dist,test*,venv
+max-complexity = 10

.github/workflows/linting.yml

@@ -0,0 +1,23 @@
+name: Linting
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Run black
+        uses: psf/black@stable
+        with:
+          options: ". --check"
+      - name: Run flake8
+        if: ${{ github.event_name == 'pull_request' }}
+        # This uses a temporary fix by pinning markup_safe.
+        # See https://github.com/grantmcconnaughey/lintly-flake8-github-action/pull/16
+        uses: bniedzie/lintly-flake8-github-action@master
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          failIf: new
+          args: "--config=.flake8 ."

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-yaml
+      - id: check-shebang-scripts-are-executable
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        language_version: python3.10
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        args:
+          - "--config=.flake8"

README.md

@@ -5,6 +5,7 @@ Retrieve statistics for a user's repositories and populate the information onto
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/astrochun/github-stats-pages/Python%20package?color=blue&label=build%20%28latest%29&logo=github)](https://github.com/astrochun/github-stats-pages/actions?query=workflow%3A%22Python+package%22)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/github-stats-pages)
 [![PyPI](https://img.shields.io/pypi/v/github-stats-pages?color=blue)](https://pypi.org/project/github-stats-pages)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/github-stats-pages?color=light%20green&label=PyPI-download)
 

conftest.py

@@ -3,19 +3,20 @@
 
 def pytest_addoption(parser):
     parser.addoption("--username", action="store", default="GitHub username")
-    parser.addoption("--token", action="store",
-                     default="GitHub API personal access token")
+    parser.addoption(
+        "--token", action="store", default="GitHub API personal access token"
+    )
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def username(request):
     name_value = request.config.option.username
     if name_value is None:
         pytest.skip()
     return name_value
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def token(request):
     name_value = request.config.option.token
     if name_value is None:

github_stats_pages/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.9"
+__version__ = "0.4.10"

github_stats_pages/gts_run.py

@@ -9,13 +9,14 @@
 
 def run_each_repo(username, token, reponame, save_csv=True):
     if save_csv:
-        os.system(f'gts {username}:{token} {reponame}')
+        os.system(f"gts {username}:{token} {reponame}")
     else:
-        os.system(f'gts {username}:{token} {reponame} no_csv')
+        os.system(f"gts {username}:{token} {reponame} no_csv")
 
 
-def get_top_paths(username: str, token: str, reponame: str,
-                  save_csv: bool = True):
+def get_top_paths(
+    username: str, token: str, reponame: str, save_csv: bool = True
+):
 
     now = dt.now()
 
@@ -25,16 +26,16 @@ def get_top_paths(username: str, token: str, reponame: str,
     if len(top_path_list) > 0:
         result = [p.raw_data for p in top_path_list]
         df = pd.DataFrame.from_records(result)
-        pandas_write_buffer(df, ['path', 'count', 'uniques'], reponame)
-        df.insert(loc=0, column='date', value=now.strftime('%Y-%m-%d'))
+        pandas_write_buffer(df, ["path", "count", "uniques"], reponame)
+        df.insert(loc=0, column="date", value=now.strftime("%Y-%m-%d"))
 
         if save_csv:
             outfile = f"{now.strftime('%Y-%m-%d-%Hh-%Mm')}-paths-stats.csv"
             path = Path(outfile)
             if not path.exists():
                 df.to_csv(path, index=False, header=True)
             else:
-                df.to_csv(path, mode='a', index=False, header=False)
+                df.to_csv(path, mode="a", index=False, header=False)
     else:
         print(f"Empty top paths for {reponame}")
 
@@ -45,4 +46,3 @@ def pandas_write_buffer(df, columns, reponame):
     print(f"> {reponame} - Top paths")
     print(buffer.getvalue())
     buffer.close()
-

github_stats_pages/repo_list.py

@@ -3,11 +3,29 @@
 import json
 import pandas as pd
 
-SHORTEN_COLUMNS = ['id', 'name', 'html_url', 'description', 'language',
-                   'fork', 'archived', 'stargazers_count', 'watchers_count',
-                   'has_issues', 'has_downloads', 'has_wiki', 'has_pages',
-                   'forks_count', 'disabled', 'open_issues_count', 'license',
-                   'forks', 'open_issues', 'watchers', 'default_branch']
+SHORTEN_COLUMNS = [
+    "id",
+    "name",
+    "html_url",
+    "description",
+    "language",
+    "fork",
+    "archived",
+    "stargazers_count",
+    "watchers_count",
+    "has_issues",
+    "has_downloads",
+    "has_wiki",
+    "has_pages",
+    "forks_count",
+    "disabled",
+    "open_issues_count",
+    "license",
+    "forks",
+    "open_issues",
+    "watchers",
+    "default_branch",
+]
 
 
 def get_repo_list(user: str) -> Tuple[list, pd.DataFrame]:
@@ -22,7 +40,7 @@ def get_repo_list(user: str) -> Tuple[list, pd.DataFrame]:
     print("get_repo_list - Retrieving repository list ...")
 
     endpoint = f"https://api.github.com/users/{user}/repos"
-    params = {'per_page': 100}
+    params = {"per_page": 100}
     response = requests.get(endpoint, params=params)
     repository_list: List[Dict] = json.loads(response.content)