feat: use poetry to generate a setup.py file from pyproject.toml

Author: andreoliwa

clit/__init__.py

@@ -16,7 +16,7 @@
 CONFIG_FILENAME = os.path.join(CONFIG_DIR, "config.ini")
 CONFIG = ConfigParser()
 # http://stackoverflow.com/questions/19359556/configparser-reads-capital-keys-and-make-them-lower-case
-CONFIG.optionxform = str
+CONFIG.optionxform = str  # type: ignore
 CONFIG.read(CONFIG_FILENAME)
 
 LOGGER = logging.getLogger(__name__)

clit/dev.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 from shutil import rmtree
 from subprocess import call, check_output
+from textwrap import dedent
 from typing import Tuple
 
 import click
@@ -167,3 +168,28 @@ def full(part):
 def changelog():
     """Preview the changelog."""
     shell(f"{PyPICommands.CHANGELOG} -u | less")
+
+
+@click.command()
+def poetry_setup_py():
+    """Use poetry to generate a setup.py file from pyproject.toml."""
+    shell("poetry build")
+    shell("tar -xvzf dist/*.gz --strip-components 1 */setup.py")
+    shell("black setup.py")
+
+    setup_py_path: Path = Path.cwd() / "setup.py"
+    lines = setup_py_path.read_text().split("\n")
+    lines.insert(
+        1,
+        dedent(
+            '''
+        """NOTICE: This file was generated automatically by the command: poetry-setup-py."""
+    '''
+        ).strip(),
+    )
+
+    # Add a hint so mypy ignores the setup() line
+    lines[-2] += "  # type: ignore"
+
+    setup_py_path.write_text("\n".join(lines))
+    click.secho("setup.py generated!", fg="green")

clit/files.py

@@ -151,7 +151,8 @@ def backup_full(ctx, dry_run: bool, kill: bool, pictures: bool):
 def shell(command_line, quiet=False, return_lines=False, **kwargs):
     """Print and run a shell command."""
     if not quiet:
-        print("$ {}".format(command_line))
+        click.secho("$ ", fg="magenta", nl=False)
+        click.secho(command_line, fg="yellow")
     if return_lines:
         kwargs.setdefault("stdout", PIPE)
 
@@ -163,7 +164,7 @@ def shell(command_line, quiet=False, return_lines=False, **kwargs):
     return stdout.split("\n") if stdout else []
 
 
-def shell_find(command_line, **kwargs):
+def shell_find(command_line, **kwargs) -> List[str]:
     """Run a find command using the shell, and return its output as a list."""
     if not command_line.startswith("find"):
         command_line = f"find {command_line}"

docs/conf.py

@@ -14,6 +14,7 @@
 """
 import sys
 import os
+from typing import Dict
 
 # If extensions (or modules to document with autodoc) are in another
 # directory, add these directories to sys.path here. If the directory is
@@ -193,7 +194,7 @@
 
 # -- Options for LaTeX output ------------------------------------------
 
-latex_elements = {
+latex_elements: Dict[str, str] = {
     # The paper size ('letterpaper' or 'a4paper').
     # 'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').

pyproject.toml

@@ -20,16 +20,16 @@ classifiers = [
 ]
 
 # TODO This is still not working properly; the scripts are created but not added to the PATH. Temporary workaround:
-# Every time the scripts below change, setup.py has to be regenerated like described below.
-# Regenerate setup.py based on this .toml file with these commands:
-# poetry build && tar -xvz --strip-components 1 -f dist/*.gz */setup.py && rm -rf dist/
+# Every time the scripts below change, run:
+# poetry run generate-setup-py
 [tool.poetry.scripts]
 backup-full = "clit.files:backup_full"
 git-local-prune = "clit.git:prune_local_branches"
 git-vacuum = "clit.git:vacuum"
 pycharm-cli = "clit.files:pycharm_cli"
 pytest-run = "clit.files:pytest_run"
 pypi = "clit.dev:pypi"
+poetry-setup-py = "clit.dev:poetry_setup_py"
 
 [tool.poetry.dependencies]
 python = "^3.6 || ^3.7"

setup.py

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-"""
-This file was generated manually.
-
-Check [tool.poetry.scripts] on pyproject.toml for instructions on how to regenerate it.
-"""
+"""NOTICE: This file was generated automatically by the command: poetry-setup-py."""
 from distutils.core import setup
 
 packages = ["clit"]
 
 package_data = {"": ["*"]}
 
-install_requires = ["SQLAlchemy", "argcomplete", "click", "colorlog", "crayons", "plumbum", "prettyconf", "requests"]
+install_requires = ["SQLAlchemy", "argcomplete", "click", "colorlog", "plumbum", "prettyconf", "requests"]
 
 entry_points = {
     "console_scripts": [
         "backup-full = clit.files:backup_full",
         "git-local-prune = clit.git:prune_local_branches",
         "git-vacuum = clit.git:vacuum",
+        "poetry-setup-py = clit.dev:poetry_setup_py",
         "pycharm-cli = clit.files:pycharm_cli",
+        "pypi = clit.dev:pypi",
         "pytest-run = clit.files:pytest_run",
     ]
 }
@@ -38,4 +36,4 @@
 }
 
 
-setup(**setup_kwargs)
+setup(**setup_kwargs)  # type: ignore