Source code for twine.commands.register

"""Module containing the logic for ``twine register``."""
# Copyright 2015 Ian Cordasco
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
import argparse
import os.path
from typing import List, cast

from twine import exceptions
from twine import package as package_file
from twine import settings

[docs]def register(register_settings: settings.Settings, package: str) -> None: """Pre-register a package name with a repository before uploading a distribution. Pre-registration is not supported on PyPI, so the ``register`` command is only necessary if you are using a different repository that requires it. :param register_settings: The configured options relating to repository registration. :param package: The path of the distribution to use for package metadata. :raises twine.exceptions.TwineException: The registration failed due to a configuration error. :raises requests.HTTPError: The repository responded with an error. """ repository_url = cast(str, register_settings.repository_config["repository"]) print(f"Registering package to {repository_url}") repository = register_settings.create_repository() if not os.path.exists(package): raise exceptions.PackageNotFound( f'"{package}" does not exist on the file system.' ) resp = repository.register( package_file.PackageFile.from_filename(package, register_settings.comment) ) repository.close() if resp.is_redirect: raise exceptions.RedirectDetected.from_args( repository_url, resp.headers["location"], ) resp.raise_for_status()
[docs]def main(args: List[str]) -> None: """Execute the ``register`` command. :param args: The command-line arguments. """ parser = argparse.ArgumentParser( prog="twine register", description="register operation is not required with", ) settings.Settings.register_argparse_arguments(parser) parser.add_argument( "package", metavar="package", help="File from which we read the package metadata.", ) parsed_args = parser.parse_args(args) register_settings = settings.Settings.from_argparse(parsed_args) # Call the register function with the args from the command line register(register_settings, parsed_args.package)