change COPYRIGHT, add docstrings

Author: Wittgen

.github/workflows/lint.yaml

@@ -0,0 +1,24 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install
+        run: pip install -r <(curl https://raw.githubusercontent.com/lsst/linting/main/requirements.txt)
+
+      - name: Run linter
+        run: flake8

COPYRIGHT

@@ -1 +1 @@
-Copyright 2022 Association of Universities for Research in Astronomy, Inc. (AURA)
+Copyright 2022 The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory

Makefile

@@ -1,3 +1,23 @@
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 # Makefile for Sphinx documentation
 #
 

rubin_changelog/changelog.py

@@ -39,7 +39,13 @@
 
 
 class ChangeLog:
+    """Retrieve, process and output changelog data"""
+
     def __init__(self, max_workers: int = 5):
+        """
+        :param max_workers: `int`
+            max number of parallel worker threads to query GitHub data
+        """
         self._github_cache = None
         self._max_workers = max_workers
 
@@ -131,12 +137,10 @@ def get_package_repos(self, products: SortedList, release: ReleaseType) -> Sorte
 
     @staticmethod
     def _ticket_number(title: str) -> int:
-        match = re.search(r'DM[\s*|-]\d+', title.upper())
+        match = re.search(r'DM[\s*|-](\d+)', title.upper())
         ticket = None
         if match:
-            res = re.findall(r"DM[\s|-]*(\d+)", match[0])
-            if len(res) == 1:
-                ticket = res[0]
+            ticket = int(match[1])
         return ticket
 
     def get_merged_tickets(self, repos: Dict) -> SortedDict:

rubin_changelog/eups.py

@@ -34,13 +34,27 @@
 
 
 class EupsData:
+    """Retrieve EUPS release data"""
+
     def __init__(self, connections: int = 10):
+        """
+        :param connections: `int`
+            number of parallel URL requests
+        """
         self._url = 'https://eups.lsst.codes/stack/src/tags/'
         self._connection_mgr = urllib3.PoolManager(maxsize=connections)
         self._connections = connections
 
     @staticmethod
-    def _process_list(data) -> List[Dict[str, str]]:
+    def _process_list(data: bytes) -> List[Dict[str, str]]:
+        """
+        process a EUPS data file
+        :param data: `bytes`
+            data from URL response
+        :return:
+            List of EUPS product dicts
+            { 'package': package, 'flavor': flavor, 'version': version }
+        """
         lines = data.split(b"\n")
         result = list()
         for line in lines:
@@ -60,6 +74,11 @@ def _process_list(data) -> List[Dict[str, str]]:
         return result
 
     def _get_url_paths(self) -> List[str]:
+        """
+        get list with url of .list files
+        :return: `List[str]`
+            List of URLs
+        """
         ext = '.list'
         params = {}
         response = requests.get(self._url, params=params)
@@ -73,6 +92,11 @@ def _get_url_paths(self) -> List[str]:
         return parent
 
     def _download(self, url: str) -> SortedDict:
+        """
+        download EUPS .list files
+        :param url: `str` URL
+        :return: `SortedDict`
+        """
         response = self._connection_mgr.request('GET', url)
         name = url.split('/')[-1].split('.')[0]
         rtag = Tag(name)
@@ -84,6 +108,13 @@ def _download(self, url: str) -> SortedDict:
             return SortedDict()
 
     def get_releases(self, release: ReleaseType) -> SortedDict:
+        """
+        Retrieve release information from EUPS
+        :param release: `ReleaseType`
+            filter by WEEKLY or REGULAR
+        :return: `SortedDict`
+            EUPS release data
+        """
         urls = self._get_url_paths()
         result = SortedDict()
         release_list = SortedDict()

rubin_changelog/github.py

@@ -17,6 +17,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 from typing import List
 
 from gql import Client, gql

rubin_changelog/jira.py

@@ -45,9 +45,9 @@ def get_tickets(self) -> Dict[str, str]:
         url = self._url
         results = dict()
         while True:
-            req_url = "".join([f"{url}?jql=project=DM&startAt={start_at}",
-                               f"&maxResults={per_page}",
-                               "&fields=key,summary"])
+            req_url = (f"{url}?jql=project=DM&startAt={start_at}"
+                       f"&maxResults={per_page}"
+                       "&fields=key,summary")
             res = requests.get(req_url, headers=self._headers)
             res_json = res.json()
             total = res_json['total']

rubin_changelog/rst.py

@@ -32,6 +32,8 @@
 
 
 class Writer:
+    """Create RST output files"""
+
     def __init__(self, outputdir: str):
         self._outputdir = outputdir
 

source/conf.py

@@ -1,3 +1,23 @@
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full