Do not depend on click. Use argparse.

These boostrap scripts cannot depend on click.

Signed-off-by: Philippe Ombredanne <[email protected]>

Author: pombredanne

docs/skeleton-usage.rst

@@ -49,7 +49,7 @@ customizing the skeleton files to your project:
 
 .. code-block:: bash
 
-    ./configure --init
+    ./configure
 
 This will initialize the virtual environment for the project, pull in the
 dependencies from PyPI and add them to the virtual environment.
@@ -77,7 +77,7 @@ Replace \<version\> with the version number of the Python being used, for exampl
 To generate requirements-dev.txt after requirements.txt has been generated:
 
 .. code-block:: bash
-    ./configure --init --dev
+    ./configure --dev
     python etc/scripts/gen_requirements_dev.py -s venv/lib/python<version>/site-packages/
 
 Note: on Windows, the ``site-packages`` directory is located at ``venv\Lib\site-packages\``
@@ -88,10 +88,11 @@ Note: on Windows, the ``site-packages`` directory is located at ``venv\Lib\site-
     .\configure --init --dev
     python .\\etc\\scripts\\gen_requirements_dev.py -s .\\venv\\Lib\\site-packages\\
 
+
 Collecting and generating ABOUT files for dependencies
 ------------------------------------------------------
 
-Ensure that the dependencies used by ``etc/scripts/bootstrap.py`` are installed:
+Ensure that the dependencies used by ``etc/scripts/fetch_thirdparty.py`` are installed:
 
 .. code-block:: bash
 
@@ -102,7 +103,7 @@ dependencies as wheels and generate ABOUT files for them:
 
 .. code-block:: bash
 
-    python etc/scripts/bootstrap.py -r requirements.txt -r requirements-dev.txt --with-deps
+    python etc/scripts/fetch_thirdparty.py -r requirements.txt -r requirements-dev.txt
 
 There may be issues with the generated ABOUT files, which will have to be
 corrected. You can check to see if your corrections are valid by running:
@@ -122,8 +123,8 @@ Usage after project initialization
 
 Once the ``requirements.txt`` and ``requirements-dev.txt`` have been generated
 and the project dependencies and their ABOUT files have been uploaded to
-thirdparty.aboutcode.org/pypi, you can configure the project without using the
-``--init`` option.
+thirdparty.aboutcode.org/pypi, you can configure the project as needed, typically
+when you update dependencies or use a new checkout.
 
 If the virtual env for the project becomes polluted, or you would like to remove
 it, use the ``--clean`` option:
@@ -146,12 +147,11 @@ update the dependencies in ``setup.cfg``, then run:
 .. code-block:: bash
 
     ./configure --clean # Remove existing virtual environment
-    ./configure --init # Create project virtual environment, pull in new dependencies
     source venv/bin/activate # Ensure virtual environment is activated
     python etc/scripts/gen_requirements.py -s venv/lib/python<version>/site-packages/ # Regenerate requirements.txt
     python etc/scripts/gen_requirements_dev.py -s venv/lib/python<version>/site-packages/ # Regenerate requirements-dev.txt
     pip install -r etc/scripts/requirements.txt # Install dependencies needed by etc/scripts/bootstrap.py
-    python etc/scripts/bootstrap.py -r requirements.txt -r requirements-dev.txt --with-deps # Collect dependency wheels and their ABOUT files
+    python etc/scripts/fetch_thirdparty.py -r requirements.txt -r requirements-dev.txt # Collect dependency wheels and their ABOUT files
 
 Ensure that the generated ABOUT files are valid, then take the dependency wheels
 and ABOUT files and upload them to thirdparty.aboutcode.org/pypi.

etc/scripts/gen_requirements.py

@@ -8,37 +8,48 @@
 # See https://github.com/nexB/skeleton for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
-import click
+import argparse
+import pathlib
+
 import utils_requirements
 
+"""
+Utilities to manage requirements files.
+NOTE: this should use ONLY the standard library and not import anything else
+because this is used for boostrapping with no requirements installed.
+"""
 
-@click.command()
-@click.option(
-    "-s",
-    "--site-packages-dir",
-    type=click.Path(exists=True, readable=True, path_type=str, file_okay=False, resolve_path=True),
-    required=True,
-    metavar="DIR",
-    help='Path to the "site-packages" directory where wheels are installed such as lib/python3.6/site-packages',
-)
-@click.option(
-    "-r",
-    "--requirements-file",
-    type=click.Path(path_type=str, dir_okay=False),
-    metavar="FILE",
-    default="requirements.txt",
-    show_default=True,
-    help="Path to the requirements file to update or create.",
-)
-@click.help_option("-h", "--help")
-def gen_requirements(site_packages_dir, requirements_file):
-    """
+
+def gen_requirements():
+    description = """
     Create or replace the `--requirements-file` file FILE requirements file with all
     locally installed Python packages.all Python packages found installed in `--site-packages-dir`
     """
+    parser = argparse.ArgumentParser(description=description)
+
+    parser.add_argument(
+        "-s",
+        "--site-packages-dir",
+        dest="site_packages_dir",
+        type=pathlib.Path,
+        required=True,
+        metavar="DIR",
+        help="Path to the 'site-packages' directory where wheels are installed such as lib/python3.6/site-packages",
+    )
+    parser.add_argument(
+        "-r",
+        "--requirements-file",
+        type=pathlib.Path,
+        metavar="FILE",
+        default="requirements.txt",
+        help="Path to the requirements file to update or create.",
+    )
+
+    args = parser.parse_args()
+
     utils_requirements.lock_requirements(
-        requirements_file=requirements_file,
-        site_packages_dir=site_packages_dir,
+        site_packages_dir=args.site_packages_dir,
+        requirements_file=args.requirements_file,
     )
 
 

etc/scripts/gen_requirements_dev.py

@@ -8,51 +8,59 @@
 # See https://github.com/nexB/skeleton for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
-import click
+import argparse
+import pathlib
+
 import utils_requirements
 
+"""
+Utilities to manage requirements files.
+NOTE: this should use ONLY the standard library and not import anything else
+because this is used for boostrapping with no requirements installed.
+"""
 
-@click.command()
-@click.option(
-    "-s",
-    "--site-packages-dir",
-    type=click.Path(exists=True, readable=True, path_type=str, file_okay=False, resolve_path=True),
-    required=True,
-    metavar="DIR",
-    help='Path to the "site-packages" directory where wheels are installed such as lib/python3.6/site-packages',
-)
-@click.option(
-    "-d",
-    "--dev-requirements-file",
-    type=click.Path(path_type=str, dir_okay=False),
-    metavar="FILE",
-    default="requirements-dev.txt",
-    show_default=True,
-    help="Path to the dev requirements file to update or create.",
-)
-@click.option(
-    "-r",
-    "--main-requirements-file",
-    type=click.Path(path_type=str, dir_okay=False),
-    default="requirements.txt",
-    metavar="FILE",
-    show_default=True,
-    help="Path to the main requirements file. Its requirements will be excluded "
-    "from the generated dev requirements.",
-)
-@click.help_option("-h", "--help")
-def gen_dev_requirements(site_packages_dir, dev_requirements_file, main_requirements_file):
-    """
+
+def gen_dev_requirements():
+    description = """
     Create or overwrite the `--dev-requirements-file` pip requirements FILE with
     all Python packages found installed in `--site-packages-dir`. Exclude
     package names also listed in the --main-requirements-file pip requirements
     FILE (that are assume to the production requirements and therefore to always
     be present in addition to the development requirements).
     """
+    parser = argparse.ArgumentParser(description=description)
+
+    parser.add_argument(
+        "-s",
+        "--site-packages-dir",
+        type=pathlib.Path,
+        required=True,
+        metavar="DIR",
+        help='Path to the "site-packages" directory where wheels are installed such as lib/python3.6/site-packages',
+    )
+    parser.add_argument(
+        "-d",
+        "--dev-requirements-file",
+        type=pathlib.Path,
+        metavar="FILE",
+        default="requirements-dev.txt",
+        help="Path to the dev requirements file to update or create.",
+    )
+    parser.add_argument(
+        "-r",
+        "--main-requirements-file",
+        type=pathlib.Path,
+        default="requirements.txt",
+        metavar="FILE",
+        help="Path to the main requirements file. Its requirements will be excluded "
+        "from the generated dev requirements.",
+    )
+    args = parser.parse_args()
+
     utils_requirements.lock_dev_requirements(
-        dev_requirements_file=dev_requirements_file,
-        main_requirements_file=main_requirements_file,
-        site_packages_dir=site_packages_dir,
+        dev_requirements_file=args.dev_requirements_file,
+        main_requirements_file=args.main_requirements_file,
+        site_packages_dir=args.site_packages_dir,
     )