feat: add pypi script

Author: andreoliwa

clit/config.py

@@ -1,5 +1,7 @@
 """Configuration helpers."""
 import json
+import os
+from typing import List
 
 from clit.constants import CONFIG_DIR
 
@@ -29,3 +31,27 @@ def dump(self, new_data):
         if isinstance(new_data, set):
             new_data = list(new_data)
         self.full_path.write_text(json.dumps(new_data))
+
+
+def cast_to_directory_list(check_existing: bool = True):
+    """Cast from a string of directories separated by colons.
+
+    Useful functions for the prettyconf module.
+
+    Optional check existing directories: throw an error if any directory does not exist.
+    """
+
+    def cast_function(value) -> List[str]:
+        """Cast function expected by prettyconf."""
+        expanded_dirs = [os.path.expanduser(dir_).rstrip("/") for dir_ in value.split(":")]
+
+        if check_existing:
+            non_existent = [d for d in expanded_dirs if not os.path.isdir(d)]
+            if non_existent:
+                raise RuntimeError(
+                    "Some directories were not found or are not directories: {}".format(":".join(non_existent))
+                )
+
+        return expanded_dirs
+
+    return cast_function

clit/constants.py

@@ -3,5 +3,5 @@
 
 SECTION_SYMLINKS_FILES = "symlinks/files"
 SECTION_SYMLINKS_DIRS = "symlinks/dirs"
-PYCHARM_APP_FULL_PATH = "/Applications/PyCharm.app/Contents/MacOS/pycharm"
+PYCHARM_MACOS_APP_PATH = Path("/Applications/PyCharm.app/Contents/MacOS/pycharm")
 CONFIG_DIR = Path("~/.config/dotfiles/").expanduser()

clit/dev.py

@@ -1,13 +1,16 @@
 """Development helpers."""
 import os
+from pathlib import Path
+from shutil import rmtree
 from subprocess import call, check_output
 from typing import Tuple
 
 import click
-import crayons
 from plumbum import FG, RETCODE
 
-from clit.constants import PYCHARM_APP_FULL_PATH
+from clit.constants import PYCHARM_MACOS_APP_PATH
+from clit.files import shell
+from clit.ui import prompt
 
 
 @click.command()
@@ -24,8 +27,8 @@ def pycharm_cli(files):
         else:
             real_file = check_output(["which", possible_file]).decode().strip()
         full_paths.append(real_file)
-    command_line = [PYCHARM_APP_FULL_PATH] + full_paths
-    print(crayons.green("Calling PyCharm with {}".format(" ".join(command_line))))
+    command_line = [PYCHARM_MACOS_APP_PATH] + full_paths
+    click.secho(f"Calling PyCharm with {' '.join(command_line)}", fg="green")
     call(command_line)
 
 
@@ -41,7 +44,7 @@ def pytest_run(delete: bool, failed: bool, count: int, reruns: int, class_names_
     from plumbum.cmd import time as time_cmd, rm
 
     if delete:
-        print(crayons.green("Removing .pytest directory", bold=True))
+        click.secho("Removing .pytest directory", fg="green", bold=True)
         rm["-rf", ".pytest"] & FG
 
     pytest_plus_args = ["pytest", "-vv", "--run-intermittent"]
@@ -65,6 +68,102 @@ def pytest_run(delete: bool, failed: bool, count: int, reruns: int, class_names_
         pytest_plus_args.append("-s")
         pytest_plus_args.extend(targets)
 
-    print(crayons.green("Running tests: time {}".format(" ".join(pytest_plus_args)), bold=True))
+    click.secho(f"Running tests: time {' '.join(pytest_plus_args)}", fg="green", bold=True)
     rv = time_cmd[pytest_plus_args] & RETCODE(FG=True)
     exit(rv)
+
+
+class PyPICommands:
+    """Commands executed by this helper script."""
+
+    # https://github.com/peritus/bumpversion
+    BUMP_VERSION = "bumpversion {part}"
+    BUMP_VERSION_DRY_RUN = f"{BUMP_VERSION} --dry-run --verbose"
+
+    # https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli
+    CHANGELOG = "conventional-changelog -i CHANGELOG.md -p angular"
+
+    BUILD_SETUP_PY = "python setup.py sdist bdist_wheel --universal"
+
+    # https://poetry.eustace.io/
+    BUILD_POETRY = "poetry build"
+
+    GIT_ADD = "git add ."
+    GIT_COMMIT = "git commit -m'{}'"
+    GIT_PUSH = "git push"
+    GIT_TAG = "git tag v{}"
+
+    # https://github.com/pypa/twine
+    # I tried using "poetry publish -u $TWINE_USERNAME -p $TWINE_PASSWORD"; the command didn't fail, but nothing was uploaded
+    # I also tried setting $TWINE_USERNAME and $TWINE_PASSWORD on the environment, but then "twine upload" didn't work for some reason.
+    TWINE_UPLOAD = "twine upload dist/*"
+
+    # https://www.npmjs.com/package/conventional-github-releaser
+    GITHUB_RELEASE = "conventional-github-releaser -p angular -v"
+
+
+@click.group()
+def pypi():
+    """Commands to publish packages on PyPI."""
+    pass
+
+
+@pypi.command()
+@click.option("--part", default="minor", type=click.Choice(["major", "minor", "patch"]))
+def full(part):
+    """The full process to upload to PyPI (bump version, changelog, package, upload)."""
+    bump_dry_run_cmd = PyPICommands.BUMP_VERSION_DRY_RUN.format(part=part)
+    bump = shell(bump_dry_run_cmd)
+    if bump.returncode != 0:
+        exit(bump.returncode)
+
+    chosen_lines = shell(
+        f'{bump_dry_run_cmd} 2>&1 | rg -e "would.+bump" -e "new version" | rg -o "\'(.+)\'"', return_lines=True
+    )
+    new_version = chosen_lines[0].strip("'")
+    commit_message = chosen_lines[1].strip("'")
+    print(f"New version: {new_version}\nCommit message: {commit_message}")
+    prompt("Were all versions correctly bumped?")
+
+    shell(PyPICommands.BUMP_VERSION.format(part=part))
+    shell(f"{PyPICommands.CHANGELOG} -s")
+
+    try:
+        dist_dir = (Path(os.curdir) / "dist").resolve()
+        print(f"Removing previous builds on {dist_dir}")
+        rmtree(str(dist_dir))
+    except OSError:
+        pass
+
+    shell(PyPICommands.BUILD_POETRY)
+    shell("ls -l dist")
+    prompt("Was a dist/ directory created with a .tar.gz and a wheel?")
+
+    shell("git diff")
+    prompt("Is the git diff correct?")
+
+    prompt(
+        "Last confirmation (point of no return):"
+        + "Changes will be committed, files will be uploaded to PyPI, a GitHub release will be created"
+    )
+
+    print("Add files, commit and push")
+    for command in (PyPICommands.GIT_ADD, PyPICommands.GIT_COMMIT.format(commit_message), PyPICommands.GIT_PUSH):
+        shell(command)
+
+    print("Create the tag but don't push it yet (conventional-github-releaser will do that)")
+    shell(PyPICommands.GIT_TAG.format(new_version))
+
+    print("Upload the files to PyPI via Twine")
+    shell(PyPICommands.TWINE_UPLOAD)
+
+    print("Create a GitHub release")
+    shell(PyPICommands.GITHUB_RELEASE)
+
+    print(f"The new version {new_version} was uploaded to PyPI")
+
+
+@pypi.command()
+def changelog():
+    """Preview the changelog."""
+    shell(f"{PyPICommands.CHANGELOG} -u | less")

clit/environments.py

@@ -4,7 +4,7 @@
 
 from prettyconf import config
 
-from libwaa.prettyconf import cast_to_directory_list
+from clit.config import cast_to_directory_list
 
 config.starting_path = os.path.expanduser("~/.config/clit")
 

clit/files.py

@@ -9,7 +9,6 @@
 from typing import List
 
 import click
-import crayons
 from plumbum import FG
 
 from clit import CONFIG, LOGGER, read_config, save_config
@@ -123,11 +122,11 @@ def sync_dir(source_dirs: List[str], destination_dirs: List[str], dry_run: bool
             rsync_args = "{dry_run}{kill}-trOlhDuzv --modify-window=2 --progress {exclude} {src}/ {dest}/".format(
                 dry_run="-n " if dry_run else "",
                 kill="--del " if kill else "",
-                exclude=" ".join(["--exclude={}".format(e) for e in RSYNC_EXCLUDE]),
+                exclude=" ".join([f"--exclude={e}" for e in RSYNC_EXCLUDE]),
                 src=src_dir,
                 dest=full_dest_dir,
             )
-            print(crayons.green("rsync {}".format(rsync_args)))
+            click.secho(f"rsync {rsync_args}", fg="green")
             os.makedirs(full_dest_dir, exist_ok=True)
             rsync[split(rsync_args)] & FG
 
@@ -140,12 +139,12 @@ def sync_dir(source_dirs: List[str], destination_dirs: List[str], dry_run: bool
 def backup_full(ctx, dry_run: bool, kill: bool, pictures: bool):
     """Perform all backups in a single script."""
     if pictures:
-        print(crayons.green("Pictures backup", bold=True))
+        click.secho("Pictures backup", bold=True, fg="green")
         from clit.environments import PICTURE_DIRS, BACKUP_DIRS
 
         sync_dir(PICTURE_DIRS, BACKUP_DIRS, dry_run, kill)
     else:
-        print(crayons.red("Choose one of the options below."))
+        click.secho("Choose one of the options below.", fg="red")
         print(ctx.get_help())
 
 

clit/ui.py

@@ -19,3 +19,8 @@ def notify(title, message):
                 Path(__file__).name, title, message
             )
         )
+
+
+def prompt(message: str) -> None:
+    """Display a prompt with a message."""
+    input(f"{message}\nPress ENTER to continue or Ctrl-C to abort")

libwaa/__init__.py

@@ -29,13 +29,13 @@ 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"
 
 [tool.poetry.dependencies]
-python = "^3.6"
+python = "^3.6 || ^3.7"
 argcomplete = "*"
 click = "*"
 colorlog = "*"
-crayons = "*"
 requests = "*"
 SQLAlchemy = "*"
 plumbum = "*"