gituptools 123

Setuptools helper for packaging Python from Gitlab.

Welcome to Gituptools

Gituptools is a helper for packing Python on Gitlab CICD runners. It basically gets as much from the runtime environment as it can to fill in all the packaging metadata that a typical setup.py file needs.

Gituptools is 100% standard library. No 3rd party dependencies.

See the Documentation for more help.

Installation

From PyPI directly:

pip install gituptools

Examples

This is all you need in a setup.py file if you are building on Gitlab CICD.

import gituptools

if __name__ == '__main__':
    gituptools.setup()

This is the optional pyproject.toml you can use.

[build-system]
requires = ["gituptools"]

This is a basic example of a .gitlab-ci.yml file to build and publish your package.

image: python:latest

stages:
    - Build
    - Publish

PyPackage:
    stage: Build
    artifacts:
        paths: [dist/*]
    script:
        # option 1: with a pyproject.toml
        - python -m install -U build
        - python -m build
        # option 2: just do it the old way
        - python setup.py sdist bdist_wheel

PyPi:
    stage: Publish
    needs:
        - job: PyPackage
          artifacts: true
    script:
        - python -m install twine
        - >
          twine upload
          --username $YOUR_USERNAME
          --password $YOUR_PASSWORD
          --verbose
          --non-interactive
          dist/*