Merge pull request #10 from cisagov/lineage/skeleton

⚠️ CONFLICT! Lineage pull request for: skeleton

.github/dependabot.yml

@@ -0,0 +1,13 @@
+---
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build.yml

@@ -18,11 +18,12 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Store installed Python version
         run: |
-          echo "::set-env name=PY_VERSION::"\
-          "$(python -c "import platform;print(platform.python_version())")"
+          echo "PY_VERSION="\
+          "$(python -c "import platform;print(platform.python_version())")" \
+          >> $GITHUB_ENV
       - name: Cache linting environments
         uses: actions/cache@v2
         with:
@@ -48,7 +49,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
@@ -82,7 +83,7 @@ jobs:
     needs: [lint, test]
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,76 @@
+---
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+name: "CodeQL"
+
+on:
+  push:
+    # Push on all branches
+    # branches: [develop]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [develop]
+  schedule:
+    - cron: '0 14 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript',
+        # 'python']
+        language: ['python']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # We must fetch at least the immediate parents so that if this is
+          # a pull request then we can checkout the head.
+          fetch-depth: 2
+
+      # If this run was triggered by a pull request event, then checkout
+      # the head of the pull request instead of the merge commit.
+      - run: git checkout HEAD^2
+        if: ${{ github.event_name == 'pull_request' }}
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a
+          # config file. By default, queries listed here will override any
+          # specified in a config file. Prefix the list here with "+" to use
+          # these queries and those in the config file. queries:
+          # ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or
+      # Java). If this step fails, then you should remove it and run the build
+      # manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following
+      # three lines and modify them (or add more) to build your code if your
+      # project uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.isort.cfg

@@ -9,7 +9,7 @@ import_heading_firstparty=cisagov Libraries
 # Should be auto-populated by seed-isort-config hook
 known_third_party=babel,dateutil,github,pytest,pytimeparse,requests,setuptools
 # These must be manually set to correctly separate them from third party libraries
-known_first_party=_version
+known_first_party=apb
 
 # Run isort under the black profile to align with our other Python linting
 profile=black

Dockerfile

@@ -17,5 +17,5 @@ LABEL org.opencontainers.image.vendor="Cyber and Infrastructure Security Agency"
 LABEL org.opencontainers.image.version=${VERSION}
 
 COPY . ./
-RUN pip install -r requirements.txt
-ENTRYPOINT ["/src/entrypoint.py"]
+RUN pip install --requirement requirements.txt
+ENTRYPOINT ["python3", "-m", "apb"]

requirements-test.txt

@@ -1,2 +1,2 @@
+--editable .[test]
 --requirement requirements.txt
--e .[test]

setup.py

@@ -31,9 +31,9 @@ def package_vars(version_file):
 
 
 setup(
-    name="All Projects Builder Action",
+    name="apb",
     # Versions should comply with PEP440
-    version=package_vars("src/_version.py")["__version__"],
+    version=package_vars("src/apb/_version.py")["__version__"],
     description="GitHub Action to rebuild respositories that haven't be built in a while.",
     long_description=readme(),
     long_description_content_type="text/markdown",
@@ -62,13 +62,13 @@ def package_vars(version_file):
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
     ],
     python_requires=">=3.6",
     # What does your project relate to?
     keywords="apb",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
-    package_data={"example": ["data/*.txt"]},
     py_modules=[splitext(basename(path))[0] for path in glob("src/*.py")],
     include_package_data=True,
     install_requires=[
@@ -94,5 +94,5 @@ def package_vars(version_file):
         ]
     },
     # Conveniently allows one to run the CLI tool as `example`
-    entry_points={"console_scripts": ["apb = entrypoint:main"]},
+    entry_points={"console_scripts": ["apb = apb.entrypoint:main"]},
 )

src/apb/__init__.py

@@ -0,0 +1,2 @@
+"""APB action module."""
+from ._version import __version__  # noqa: F401

src/apb/__main__.py

@@ -0,0 +1,5 @@
+"""Code to run if this package is used as a Python module."""
+
+from .entrypoint import main
+
+main()

src/entrypoint.py → src/apb/entrypoint.py

@@ -1,13 +1,11 @@
-#!/usr/bin/env python3
-"""GitHub Action to rebuild respositories that haven't be built in a while."""
+"""GitHub Action to rebuild respositories that haven't been built in a while."""
 
 # Standard Python Libraries
 from datetime import datetime
 import json
 import logging
 import os
 from pathlib import Path
-import sys
 from typing import Generator, Optional
 
 # Third-Party Libraries
@@ -166,7 +164,3 @@ def main() -> int:
         json.dump(all_repo_status, f, indent=4, sort_keys=True)
     logging.info("Completed.")
     return 0
-
-
-if __name__ == "__main__":
-    sys.exit(main())

tests/test_apb.py

@@ -8,10 +8,10 @@
 import pytest
 
 # cisagov Libraries
-import _version
+import apb
 
 # define sources of version strings
-PROJECT_VERSION = _version.__version__
+PROJECT_VERSION = apb.__version__
 RELEASE_TAG = os.getenv("RELEASE_TAG")