Skip to main content

Sample Travis CI + Pypi integration

Project description

This is a very short guide to using Travis CI with your GitHub hosted code repository to automatically deploy a python package to Pypi. If you’re new to continuous integration or would like some more information on what Travis CI does, read Travis CI Core Concepts for Beginners first.

In this guide, we will be creating a Travis CI pipeline to automatically:

  • Start mongodb service. Requires mongo>=4.0
  • Run pytest tests
  • Distributes the package to pypi

All the code can be found on https://github.com/musyoka-morris/travis-pypi-integration

Prerequisites

To proceed, make sure you have a Travis CI account. You can easily create one by visiting https://travis-ci.org/ and then click the Sign in with Github button.

1. Install Travis CLI

First we need to install Travis CLI which is written in Ruby and published as a gem. We will be using this tool to encrypt the Pypi password.

To install the gem:

sudo gem install travis

ERROR: can’t find header files for ruby …

If you run into the error can’t find header files for ruby, then you also need to have the ruby headers installed.

The stack overflow answer saved me. In summary, you need to install ruby development headers as follows:

For Debian, and other distributions using Debian style packaging:

sudo apt-get install ruby-dev

For Ubuntu:

sudo apt-get install ruby-all-dev

2. Create a .travis.yml file

.travis.yml

language: python  # We are using Python language
install: pip install -r requirements.txt  # Install requirements
script: pytest  # Run pytest tests

MongoDB service

Add instructions to start mongodb service.

This section is optional if you are not interested in MongoDB service. I simply left it here to serve as a guide for other services of interest.

...
services:
  - mongodb
before_script:
  - sleep 15  # Sleep for 15 seconds to ensure the service is started before we issue any commands

By default, travis loads mongo v2.4. We instruct travis to load mongo v4.0

...
dist: xenial
addons:
  apt:
    sources:
      - mongodb-4.0-xenial  # As defined on Travis Source safelist

Pypi Deployment

Add instruction for deployment to pypi

...
deploy:
  provider: pypi
  user: musyoka-morris  # Replace this with your pypi username. Password will be provided later
  distributions: sdist bdist_wheel
  skip_existing: true

3. Add encrypted pypi password

Notice that so far we have not specified our pypi password. The easiest way to add the password encrypted with the public key is to use Travis CLI:

travis encrypt Your-Password-Here –add deploy.password

Note: This assumes you are running the command in your project directory. If not, add -r owner/project.

The command automatically adds your encrypted password on the .travis.yml file. your .travis.yml file should look like this:

...
deploy:
    ...
    user: musyoka-morris
    password:
        secure: YourEncryptedPasswordHere

4. Push to GIT

Travis configuration is ready. Simply push the code to the master branch and Travis will take care of the rest.

The complete .travis.yml file can be found on Github https://github.com/musyoka-morris/travis-pypi-integration

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

travis_pypi_integration-2.1.2.tar.gz (3.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page