pop-release 2.0.3

What is POP?

This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

• Intro to Plugin Oriented Programming (POP)

• pop-awesome

• pop-create

Prerequisites

• Python 3.6+

• git (if installing from source, or contributing to the project)

Installation

If wanting to use pop-release, you can do so by either installing from PyPI or from source.

# clone repo
git clone git@gitlab.com/saltstack/pop/pop-release.git
cd pop-release

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Traditional

Set up a file called “.pypirc” in your home directory. Your username will be “__token__” and your password will be an API token With this method you can’t choose between the configured profiles.

~/.pypirc

[distutils]
index-servers=
    pypi

[pypi]
repository = https://upload.pypi.org/legacy/
username = __token__
password = pypi-<pypi_api_token>

With your credentials set up, you can simply run the pop-release command in the root of the directory that contains your source code. The only argument you need is a semantic version number.

pop-release 1.0.0-alpha

Power User

Using the acct plugin, we can have multiple named profiles. The “default” and “testing” examples below show the bare minimum of configuration required. Any options that can be used by a twine.settings.Settings object can be included in a twine acct profile.

credentials.yaml

twine:
    default:
        username: __token__
        password: pypi-api-auth-token
        repository_name: pypi
        repository_url: https://upload.pypi.org/legacy/
    testing:
        username: __token__
        password: pypi-testing-api-auth-token
        repository_name: testpypi
        repository_url: https://test.pypi.org/legacy/
    internal:
        sign: True
        sign_with: gpg
        identity:
        username: __token__
        password: pypi-internal-api-auth-token
        comment: My project's private repository
        config_file: ~/.pypirc
        skip_existing: False
        cacert:
        client_cert:
        repository_name: internal_pypi
        repository_url: https://pypi.<my_domain>.com/api

Now encrypt your credentials with acct

acct encrypt credentials.yaml

If this is the first time you used the command, it will output a fernet key. Save this key to the environment:

export ACCT_KEY="i6KbvytHAYWYiWBV48x5Ao0M3xuP-7Yzyi5K5g4eRQw="

There will also be a new file created called <credentials_file_name>.fernet. Save the full path to this file to your environment:

export ACCT_FILE="/home/myuser/.../credentials.yaml.fernet"

Now you can run pop-release using your encrypted credentials. The profile called “default” will be used implicitly. You can choose a profile for running pop-release by using the –acct-profile option.

PyPi release using the default profile:

pop-release 2.0.0

PyPi testing release:

pop-release 2.0.0 --acct-profile=testing