autopub 0.2.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

autopub/base copy.py

@@ -0,0 +1,159 @@
+import os
+import re
+import subprocess
+
+from pathlib import Path
+from tomlkit import parse
+
+
+def dict_get(_dict, keys, default=None):
+    """Query nested dictionary with list of keys, returning None if not found."""
+    for key in keys:
+        if isinstance(_dict, dict):
+            _dict = _dict.get(key, default)
+        else:
+            return default
+    return _dict
+
+
+# Determine CI/CD environment
+
+if os.environ.get("CIRCLECI"):
+    CI_SYSTEM = "circleci"
+    CIRCLE_PROJECT_USERNAME = os.environ.get("CIRCLE_PROJECT_USERNAME")
+    CIRCLE_PROJECT_REPONAME = os.environ.get("CIRCLE_PROJECT_REPONAME")
+    REPO_SLUG = f"{CIRCLE_PROJECT_USERNAME}/{CIRCLE_PROJECT_REPONAME}"
+elif os.environ.get("GITHUB_WORKFLOW"):
+    CI_SYSTEM = "github"
+    REPO_SLUG = os.environ.get("GITHUB_REPOSITORY")
+elif os.environ.get("TRAVIS"):
+    CI_SYSTEM = "travis"
+    REPO_SLUG = os.environ.get("TRAVIS_REPO_SLUG")
+else:
+    CI_SYSTEM = os.environ.get("CI_SYSTEM", None)
+    REPO_SLUG = os.environ.get("REPO_SLUG", None)
+
+# Project root and file name configuration
+
+PROJECT_ROOT = os.environ.get("PROJECT_ROOT")
+PYPROJECT_FILE_NAME = os.environ.get("PYPROJECT_FILE_NAME", "pyproject.toml")
+
+if PROJECT_ROOT:
+    ROOT = Path(PROJECT_ROOT)
+else:
+    ROOT = Path(
+        subprocess.check_output(["git", "rev-parse", "--show-toplevel"])
+        .decode("ascii")
+        .strip()
+    )
+
+PYPROJECT_FILE = ROOT / PYPROJECT_FILE_NAME
+
+# Retrieve configuration from pyproject file
+
+if os.path.exists(PYPROJECT_FILE):
+    config = parse(open(PYPROJECT_FILE).read())
+else:
+    raise SystemExit(f"Could not find pyproject file at: {PYPROJECT_FILE}")
+
+PROJECT_NAME = dict_get(config, ["tool", "autopub", "project-name"])
+if not PROJECT_NAME:
+    PROJECT_NAME = dict_get(config, ["tool", "poetry", "name"])
+if not PROJECT_NAME:
+    raise SystemExit(
+        "Could not determine project name. Under the pyproject file's "
+        '[tool.autopub] header, add:\nproject-name = "YourProjectName"'
+    )
+
+RELEASE_FILE_NAME = dict_get(
+    config, ["tool", "autopub", "release-file"], default="RELEASE.md"
+)
+RELEASE_FILE = ROOT / RELEASE_FILE_NAME
+
+CHANGELOG_FILE_NAME = dict_get(
+    config, ["tool", "autopub", "changelog-file"], default="CHANGELOG.md"
+)
+CHANGELOG_FILE = ROOT / CHANGELOG_FILE_NAME
+
+CHANGELOG_HEADER = dict_get(
+    config, ["tool", "autopub", "changelog-header"], default="========="
+)
+
+VERSION_HEADER = dict_get(config, ["tool", "autopub", "version-header"], default="-")
+VERSION_STRINGS = dict_get(config, ["tool", "autopub", "version-strings"], default=[])
+
+TAG_PREFIX = dict_get(config, ["tool", "autopub", "tag-prefix"], default="")
+
+PYPI_URL = dict_get(config, ["tool", "autopub", "pypi-url"])
+
+BUILD_SYSTEM = dict_get(config, ["tool", "autopub", "build-system"])
+if not BUILD_SYSTEM:
+    build_requires = dict_get(config, ["build-system", "requires"])
+    if "poetry" in build_requires:
+        BUILD_SYSTEM = "poetry"
+    elif "setuptools" in build_requires:
+        BUILD_SYSTEM = "setuptools"
+
+# Git configuration
+
+GIT_USERNAME = dict_get(config, ["tool", "autopub", "git-username"])
+GIT_EMAIL = dict_get(config, ["tool", "autopub", "git-email"])
+
+# GitHub
+
+GITHUB_TOKEN = os.environ.get("GITHUB_TOKEN", None)
+APPEND_GITHUB_CONTRIBUTOR = dict_get(
+    config, ["tool", "autopub", "append-github-contributor"], False
+)
+
+
+def run_process(popenargs, encoding="utf-8"):
+    return subprocess.check_output(popenargs).decode(encoding).strip()
+
+
+def git(popenargs):
+    # Do not decode ASCII for commit messages so emoji are preserved
+    return subprocess.check_output(["git", *popenargs])
+
+
+def check_exit_code(popenargs):
+    return subprocess.call(popenargs, shell=True)
+
+
+def get_project_version():
+    VERSION_REGEX = re.compile(r"^version\s*=\s*\"(?P<version>\d+\.\d+\.\d+)\"$")
+
+    with open(PYPROJECT_FILE) as f:
+        for line in f:
+            match = VERSION_REGEX.match(line)
+
+            if match:
+                return match.group("version")
+
+    return None
+
+
+def get_release_info():
+    RELEASE_TYPE_REGEX = re.compile(r"^[Rr]elease [Tt]ype: (major|minor|patch)$")
+
+    with open(RELEASE_FILE, "r") as f:
+        line = f.readline()
+        match = RELEASE_TYPE_REGEX.match(line)
+
+        if not match:
+            raise SystemExit(
+                "The RELEASE file should start with 'Release type' and "
+                "specify one of the following values: major, minor, or patch."
+            )
+
+        type_ = match.group(1)
+        changelog = "".join([l for l in f.readlines()]).strip()
+
+    return type_, changelog
+
+
+def configure_git():
+    if not GIT_USERNAME or not GIT_EMAIL:
+        raise SystemExit("git-username and git-email must be defined in the pyproject file")
+    git(["config", "user.name", GIT_USERNAME])
+    git(["config", "user.email", GIT_EMAIL])

autopub/base.py

@@ -1,8 +1,9 @@
 import os
 import re
 import subprocess
-
+import sys
 from pathlib import Path
+
 from tomlkit import parse
 
 
@@ -23,7 +24,7 @@ if os.environ.get("CIRCLECI"):
     CIRCLE_PROJECT_USERNAME = os.environ.get("CIRCLE_PROJECT_USERNAME")
     CIRCLE_PROJECT_REPONAME = os.environ.get("CIRCLE_PROJECT_REPONAME")
     REPO_SLUG = f"{CIRCLE_PROJECT_USERNAME}/{CIRCLE_PROJECT_REPONAME}"
-elif os.environ.get("GITHUB_WORKFLOW"):
+elif os.environ.get("GITHUB_ACTIONS") == "true":
     CI_SYSTEM = "github"
     REPO_SLUG = os.environ.get("GITHUB_REPOSITORY")
 elif os.environ.get("TRAVIS"):
@@ -54,16 +55,20 @@ PYPROJECT_FILE = ROOT / PYPROJECT_FILE_NAME
 if os.path.exists(PYPROJECT_FILE):
     config = parse(open(PYPROJECT_FILE).read())
 else:
-    raise SystemExit(f"Could not find pyproject file at: {PYPROJECT_FILE}")
+    print(f"Could not find pyproject file at: {PYPROJECT_FILE}")
+    sys.exit(1)
 
 PROJECT_NAME = dict_get(config, ["tool", "autopub", "project-name"])
 if not PROJECT_NAME:
     PROJECT_NAME = dict_get(config, ["tool", "poetry", "name"])
 if not PROJECT_NAME:
-    raise SystemExit(
+    PROJECT_NAME = dict_get(config, ["project", "name"])
+if not PROJECT_NAME:
+    print(
         "Could not determine project name. Under the pyproject file's "
         '[tool.autopub] header, add:\nproject-name = "YourProjectName"'
     )
+    sys.exit(1)
 
 RELEASE_FILE_NAME = dict_get(
     config, ["tool", "autopub", "release-file"], default="RELEASE.md"
@@ -86,14 +91,6 @@ TAG_PREFIX = dict_get(config, ["tool", "autopub", "tag-prefix"], default="")
 
 PYPI_URL = dict_get(config, ["tool", "autopub", "pypi-url"])
 
-BUILD_SYSTEM = dict_get(config, ["tool", "autopub", "build-system"])
-if not BUILD_SYSTEM:
-    build_requires = dict_get(config, ["build-system", "requires"])
-    if "poetry" in build_requires:
-        BUILD_SYSTEM = "poetry"
-    elif "setuptools" in build_requires:
-        BUILD_SYSTEM = "setuptools"
-
 # Git configuration
 
 GIT_USERNAME = dict_get(config, ["tool", "autopub", "git-username"])
@@ -107,8 +104,14 @@ APPEND_GITHUB_CONTRIBUTOR = dict_get(
 )
 
 
-def run_process(popenargs, encoding="utf-8"):
-    return subprocess.check_output(popenargs).decode(encoding).strip()
+def run_process(popenargs, encoding="utf-8", env=None):
+    if env is not None:
+        env = {**os.environ, **env}
+    try:
+        return subprocess.check_output(popenargs, encoding=encoding, env=env).strip()
+    except subprocess.CalledProcessError as e:
+        print(e.output, file=sys.stderr)
+        sys.exit(1)
 
 
 def git(popenargs):
@@ -121,16 +124,12 @@ def check_exit_code(popenargs):
 
 
 def get_project_version():
-    VERSION_REGEX = re.compile(r"^version\s*=\s*\"(?P<version>\d+\.\d+\.\d+)\"$")
-
-    with open(PYPROJECT_FILE) as f:
-        for line in f:
-            match = VERSION_REGEX.match(line)
-
-            if match:
-                return match.group("version")
-
-    return None
+    # Backwards compat: Try poetry first and then fall "back" to standards
+    version = dict_get(config, ["tool", "poetry", "version"])
+    if version is None:
+        return dict_get(config, ["project", "version"])
+    else:
+        return version
 
 
 def get_release_info():
@@ -141,10 +140,11 @@ def get_release_info():
         match = RELEASE_TYPE_REGEX.match(line)
 
         if not match:
-            raise SystemExit(
+            print(
                 "The RELEASE file should start with 'Release type' and "
                 "specify one of the following values: major, minor, or patch."
             )
+            sys.exit(1)
 
         type_ = match.group(1)
         changelog = "".join([l for l in f.readlines()]).strip()
@@ -154,6 +154,7 @@ def get_release_info():
 
 def configure_git():
     if not GIT_USERNAME or not GIT_EMAIL:
-        raise SystemExit("git-username and git-email must be defined in the pyproject file")
+        print("git-username and git-email must be defined in the pyproject file")
+        sys.exit(1)
     git(["config", "user.name", GIT_USERNAME])
     git(["config", "user.email", GIT_EMAIL])

autopub/build_release.py

@@ -3,13 +3,12 @@ import sys
 
 sys.path.append(os.path.dirname(__file__))  # noqa
 
-from base import BUILD_SYSTEM, run_process
-
-if BUILD_SYSTEM == "poetry":
-    build_cmd = ["poetry", "build"]
-else:
-    build_cmd = ["python", "setup.py", "sdist", "bdist_wheel"]
+from base import git, run_process
 
 
 def build_release():
-    run_process(build_cmd)
+    env = None
+    if "SOURCE_DATE_EPOCH" not in os.environ:
+        ctime = git(["log", "-1", "--pretty=%ct"]).decode().strip()
+        env = {"SOURCE_DATE_EPOCH": ctime}
+    run_process([sys.executable, "-m", "build"], env=env)

autopub/check_release.py

@@ -7,9 +7,13 @@ from base import CI_SYSTEM, RELEASE_FILE, run_process
 
 
 def check_release():
-    if not os.path.exists(RELEASE_FILE):
+    needs_release = os.path.exists(RELEASE_FILE)
+    if not needs_release:
         print("Not releasing a new version because there is no RELEASE file.")
         if CI_SYSTEM == "circleci":
             run_process(["circleci", "step", "halt"])
-        elif CI_SYSTEM == "github" or CI_SYSTEM == "travis":
+        elif CI_SYSTEM == "travis":
             sys.exit(1)
+    if CI_SYSTEM == "github":
+        with open(os.path.expandvars("$GITHUB_OUTPUT"), "a") as f:
+            f.write("autopub_release={}\n".format("true" if needs_release else "false"))

autopub/create_github_release.py

@@ -5,20 +5,20 @@ import time
 sys.path.append(os.path.dirname(__file__))  # noqa
 
 from base import (
-    run_process,
-    check_exit_code,
-    get_project_version,
-    configure_git,
     PROJECT_NAME,
     REPO_SLUG,
     TAG_PREFIX,
+    check_exit_code,
+    configure_git,
+    get_project_version,
     get_release_info,
+    run_process,
 )
 
 
 def create_github_release():
     try:
-        from github_release import gh_release_create, gh_asset_upload
+        from .vendor.github_release import gh_asset_upload, gh_release_create
     except ModuleNotFoundError:
         print("Cannot create GitHub release due to missing dependency: github_release")
         sys.exit(1)

autopub/prepare_release.py

@@ -6,17 +6,20 @@ sys.path.append(os.path.dirname(__file__))  # noqa
 
 from datetime import datetime
 
+import tomlkit
 from base import (
-    configure_git,
-    get_release_info,
-    run_process,
     CHANGELOG_FILE,
     CHANGELOG_HEADER,
+    PYPROJECT_FILE,
     ROOT,
     VERSION_HEADER,
     VERSION_STRINGS,
+    configure_git,
+    dict_get,
+    get_project_version,
+    get_release_info,
 )
-
+from dunamai import Version
 from github_contributor import append_github_contributor
 
 
@@ -38,20 +41,22 @@ def update_version_strings(file_path, new_version):
 def prepare_release():
     configure_git()
 
-    POETRY_DUMP_VERSION_OUTPUT = re.compile(
-        r"Bumping version from \d+\.\d+\.\d+ to (?P<version>\d+\.\d+\.\d+)"
-    )
-
     type_, release_changelog = get_release_info()
 
-    output = run_process(["poetry", "version", type_])
-    version_match = POETRY_DUMP_VERSION_OUTPUT.match(output)
+    version = Version(get_project_version())
+    new_version = version.bump({"major": 0, "minor": 1, "patch": 2}[type_]).serialize()
+
+    with open(PYPROJECT_FILE, "r") as f:
+        config = tomlkit.load(f)
 
-    if not version_match:
-        print("Unable to bump the project version using Poetry")
-        sys.exit(1)
+    poetry = dict_get(config, ["tool", "poetry", "version"])
+    if poetry:
+        config["tool"]["poetry"]["version"] = new_version
+    else:
+        config["project"]["version"] = new_version
 
-    new_version = version_match.group("version")
+    with open(PYPROJECT_FILE, "w") as f:
+        config = tomlkit.dump(config, f)
 
     if VERSION_STRINGS:
         for version_file in VERSION_STRINGS:

autopub/publish_release.py

@@ -1,22 +1,17 @@
+import glob
 import os
 import sys
 
 sys.path.append(os.path.dirname(__file__))  # noqa
 
-from base import BUILD_SYSTEM, PYPI_URL, run_process
-
-poetry_pub = ["poetry", "publish", "-u", "$PYPI_USERNAME", "-p", "$PYPI_PASSWORD"]
-
-if PYPI_URL:
-    twine_pub = ["twine", "upload", "--repository-url", PYPI_URL, "dist/*"]
-else:
-    twine_pub = ["twine", "upload", "dist/*"]
-
-if BUILD_SYSTEM == "poetry":
-    pub_cmd = poetry_pub
-else:
-    pub_cmd = twine_pub
+from base import PYPI_URL, run_process
 
 
 def publish_release():
-    run_process(pub_cmd)
+    env = None
+    if PYPI_URL:
+        env = {"TWINE_REPOSITORY_URL": PYPI_URL}
+    dists = glob.glob("dist/*")
+    run_process(
+        [sys.executable, "-m", "twine", "upload", "--non-interactive", *dists], env=env
+    )