diff options
| -rw-r--r-- | setup.py | 11 | ||||
| -rw-r--r-- | src/wikiget/client.py | 2 | ||||
| -rw-r--r-- | src/wikiget/dl.py | 2 | ||||
| -rw-r--r-- | src/wikiget/exceptions.py | 2 | ||||
| -rw-r--r-- | src/wikiget/file.py | 2 | ||||
| -rw-r--r-- | src/wikiget/logging.py | 2 | ||||
| -rw-r--r-- | src/wikiget/parse.py | 2 | ||||
| -rw-r--r-- | src/wikiget/validations.py | 2 | ||||
| -rw-r--r-- | src/wikiget/version.py | 4 | ||||
| -rw-r--r-- | src/wikiget/wikiget.py | 2 |
10 files changed, 27 insertions, 4 deletions
@@ -15,9 +15,14 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. -# This is a stub file for older versions of pip, setuptools, etc. that aren't fully -# compatible with the latest Python packaging standards. -# See <https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html> +"""Configure the program for packaging. + +This is a stub file for older versions of pip, setuptools, etc. that aren't fully +compatible with the latest Python packaging standards. Project metadata and dependencies +have been moved to pyproject.toml. + +See <https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html> for info. +""" from setuptools import setup diff --git a/src/wikiget/client.py b/src/wikiget/client.py index 2fc4a6c..3a6e40f 100644 --- a/src/wikiget/client.py +++ b/src/wikiget/client.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Handle API calls (via mwclient) for site and image information.""" + import logging from argparse import Namespace diff --git a/src/wikiget/dl.py b/src/wikiget/dl.py index 722bf62..5e2a6cb 100644 --- a/src/wikiget/dl.py +++ b/src/wikiget/dl.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Prepare and process file downloads.""" + import logging import sys from argparse import Namespace diff --git a/src/wikiget/exceptions.py b/src/wikiget/exceptions.py index c72a589..d9ca8b3 100644 --- a/src/wikiget/exceptions.py +++ b/src/wikiget/exceptions.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Define exceptions specific to the program.""" + class ParseError(Exception): """Raised when some input is unable to be parsed as valid.""" diff --git a/src/wikiget/file.py b/src/wikiget/file.py index a362aff..36ce892 100644 --- a/src/wikiget/file.py +++ b/src/wikiget/file.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Define a File class for representing individual files to be downloaded.""" + from pathlib import Path from mwclient.image import Image diff --git a/src/wikiget/logging.py b/src/wikiget/logging.py index 6614a15..e5b955a 100644 --- a/src/wikiget/logging.py +++ b/src/wikiget/logging.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Configure program log configuration and adapters.""" + from __future__ import annotations import logging diff --git a/src/wikiget/parse.py b/src/wikiget/parse.py index 1deaacf..026062e 100644 --- a/src/wikiget/parse.py +++ b/src/wikiget/parse.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Parse download targets and batch files.""" + from __future__ import annotations import fileinput diff --git a/src/wikiget/validations.py b/src/wikiget/validations.py index 7c2b5ae..bde39df 100644 --- a/src/wikiget/validations.py +++ b/src/wikiget/validations.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Validate file and site input and verify file hashes.""" + from __future__ import annotations import hashlib diff --git a/src/wikiget/version.py b/src/wikiget/version.py index 804c60f..0fe1802 100644 --- a/src/wikiget/version.py +++ b/src/wikiget/version.py @@ -15,4 +15,6 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. -__version__ = "0.8.0" +"""Set the version string of the program.""" + +__version__ = "0.8.0.dev0" diff --git a/src/wikiget/wikiget.py b/src/wikiget/wikiget.py index cac8694..870f7a2 100644 --- a/src/wikiget/wikiget.py +++ b/src/wikiget/wikiget.py @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Wikiget. If not, see <https://www.gnu.org/licenses/>. +"""Set up the command-line interface and handle program start and exit.""" + from __future__ import annotations import argparse |