Changes for deployment (#12)

.github/workflows/test_docker.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ['33', '34']
+        version: ['34', '35']
     container:
       image: registry.fedoraproject.org/fedora:${{ matrix.version }}
     steps:

config/dpkg/changelog

@@ -1,5 +1,5 @@
-dfkinds (20170604-1) unstable; urgency=low
+dfkinds (20211228-1) unstable; urgency=low
 
   * Auto-generated
 
- -- Log2Timeline <log2timeline-dev@googlegroups.com>  Sun, 04 Jun 2017 20:14:50 +0200
+ -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Tue, 28 Dec 2021 04:57:45 +0100

dfkinds/__init__.py

@@ -6,4 +6,4 @@
 different tools.
 """
 
-__version__ = '20170604'
+__version__ = '20211228'

docs/sources/api/dfkinds.rst

@@ -0,0 +1,10 @@
+dfkinds package
+===============
+
+Module contents
+---------------
+
+.. automodule:: dfkinds
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/sources/api/modules.rst

@@ -1,7 +1,7 @@
-acstore
+dfkinds
 =======
 
 .. toctree::
    :maxdepth: 4
 
-   acstore
+   dfkinds

docs/sources/user/Installation-instructions.md

@@ -63,5 +63,5 @@ To install the release versions of the dependencies run:
 ```
 set PYTHONPATH=.
 
-C:\Python38\python.exe tools\update.py --preset dfkinds
+C:\Python3\python.exe tools\update.py --preset dfkinds
 ```

setup.py

@@ -155,22 +155,23 @@ def parse_requirements_from_file(path):
   Args:
     path (str): path to the requirements file.
 
-  Yields:
-    str: name and optional version information of the required package.
+  Returns:
+    list[str]: name and optional version information of the required packages.
   """
   with open(path, 'r') as file_object:
     file_contents = file_object.read()
 
+  requirements = []
   for requirement in pkg_resources.parse_requirements(file_contents):
     try:
       name = str(requirement.req)
     except AttributeError:
       name = str(requirement)
 
-    if name.startswith('pip '):
-      continue
+    if not name.startswith('pip '):
+      requirements.append(name)
 
-    yield name
+  return requirements
 
 
 dfkinds_description = (
@@ -200,7 +201,7 @@ def parse_requirements_from_file(path):
         'Programming Language :: Python',
     ],
     packages=find_packages('.', exclude=[
-        'tests', 'tests.*', 'utils']),
+        'docs', 'tests', 'tests.*', 'utils']),
     package_dir={
         'dfkinds': 'dfkinds'
     },

tox.ini

@@ -28,6 +28,14 @@ deps =
 commands =
     codecov
 
+[testenv:docs]
+usedevelop = true
+deps =
+    -rdocs/requirements.txt
+commands =
+    sphinx-build -b html -d build/doctrees docs dist/docs
+    sphinx-build -b linkcheck docs dist/docs
+
 [testenv:pylint]
 skipsdist=True
 pip_pre = True

utils/update_release.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+#
+# Script that makes changes in preparation of a new release, such as updating
+# the version and documentation.
+
+EXIT_FAILURE=1;
+EXIT_SUCCESS=0;
+
+VERSION=`date -u +"%Y%m%d"`
+DPKG_DATE=`date -R`
+
+# Update the Python module version.
+sed "s/__version__ = '[0-9]*'/__version__ = '${VERSION}'/" -i dfkinds/__init__.py
+
+# Update the version in the dpkg configuration files.
+cat > config/dpkg/changelog << EOT
+dfkinds (${VERSION}-1) unstable; urgency=low
+
+  * Auto-generated
+
+ -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  ${DPKG_DATE}
+EOT
+
+# Regenerate the API documentation.
+tox -edocs
+
+exit ${EXIT_SUCCESS};
+