publish_new_version.py

"""A script that publish a new version of the library to PyPI."""

import os

import build
import toml
from twine.commands.upload import upload
from twine.settings import Settings

PROJECT_DIR = os.path.dirname(os.path.realpath(__file__))
SOURCE_DIR = os.path.abspath(os.path.join(PROJECT_DIR, "src"))
TOML_FILE_PATH = os.path.join(SOURCE_DIR, "pyproject.toml")


def version_file_name(version: str) -> str:
    """Return the name of the file that contains the version number."""
    return f"grouped_sampling-{version}.tar.gz"


def version_file_path(version: str) -> str:
    """Return the path of the file that contains the version number."""
    return os.path.join(PROJECT_DIR, "dist", version_file_name(version))


def increase_version():
    """Increase the version number by one."""
    pyproject = toml.load(TOML_FILE_PATH)
    old_version = pyproject["project"]["version"]
    major, minor, patch = old_version.split(".")
    patch = int(patch) + 1
    new_version = f"{major}.{minor}.{patch}"
    pyproject["project"]["version"] = new_version
    with open(TOML_FILE_PATH, "w", encoding="utf-8") as toml_file:
        toml.dump(pyproject, toml_file)
    return new_version


def decrease_version():
    """Decrease the version number by one."""
    pyproject = toml.load("src/pyproject.toml")
    old_version = pyproject["project"]["version"]
    major, minor, patch = old_version.split(".")
    patch = int(patch) - 1
    new_version = f"{major}.{minor}.{patch}"
    return new_version


def version_already_exists(new_version: str) -> bool:
    """Check if the new version already exists."""
    return os.path.exists(version_file_path(new_version))


def build_version(new_version: str) -> None:
    """Build the new version."""
    if version_already_exists(new_version):
        return
    output_directory = os.path.join(PROJECT_DIR, "dist")
    builder = build.ProjectBuilder(
        srcdir=SOURCE_DIR,
    )
    builder.build(output_directory=output_directory, distribution="sdist")
    # return only when the build is finished
    while not version_already_exists(new_version):
        pass


def publish_version(new_version: str):
    """Publish the new version to PyPI."""
    upload_settings = Settings(
        username="__token__",
        password=get_pypi_api_token(),
        repository="pypi",
        disable_progress_bar=True,
    )
    upload(
        upload_settings=upload_settings,
        dists=[version_file_path(new_version)],
    )


def get_pypi_api_token() -> str:
    """Return the PyPI API token."""
    pypi_api_token_path = os.path.join(PROJECT_DIR, "pypi_api_token.txt")
    if not os.path.exists(pypi_api_token_path):
        pypi_api_token = input("Please enter your PyPI API token: ")
        with open(pypi_api_token_path, "w", encoding="utf-8") as pypi_api_token_file:
            pypi_api_token_file.write(pypi_api_token)
    with open(pypi_api_token_path, "r", encoding="utf-8") as pypi_api_token_file:
        pypi_api_token = pypi_api_token_file.read().strip()
    return pypi_api_token


def main():
    """Publish a new version of the library to PyPI. The new version is the old version + 1"""
    # run build
    new_version: str = increase_version()
    build_version(new_version=new_version)
    # Publish the new version to PyPI.
    publish_version(new_version=new_version)


if __name__ == "__main__":
    main()