pombredanne / conda-smithy

The tool for managing conda-forge feedstocks.

Overview

conda-smithy is a tool for combining a conda recipe with configurations to build using freely hosted CI services into a single repository, also known as a feedstock. conda-smithy is still a work-in-progress, but when complete, conda-smithy will:

• Create a git repo with a conda recipe and the files to run conda builds via CI services.
• Register the repo on github and push it.
• Connect the repo to the CI services travis-ci.org, appveyor.com, circleci.com

Installation

The easiest way to install conda-smithy is to use conda and conda-forge:

conda install -c conda-forge conda-smithy

To install conda-smithy from source, see the requirements file in requirements.txt, clone this repo, and python setup.py install.

Setup

You need a token from github, travis-ci.org, appveyor.com and circleci.com to try out conda-smithy. The commands which need this will tell you where to get these tokens and where to place them. If you need help getting tokens please ask on the conda-forge google group.

You should be able to test parts of conda-smithy with whatever tokens you have. For example, you should be able to conda smithy register-github without the CI service tokens.

Making a new feedstock

1. Make the feedstock repo: conda smithy init <directory_of_conda_recipe>. For a recipe called foo, this creates a directory called foo-feedstock, populates it with CI setup skeletons, adds the recipe under recipe and initializes it as a git repo.
2. Create a github repo: conda smithy register-github --organization conda-forge ./foo-feedstock. This requires a github token. You can try it out with a github user account instead of an organization by replacing the organization argument with --user github_user_name.
3. Register the feedstock with CI services: conda smithy register-ci --organization conda-forge ./foo-feedstock. This requires tokens for the CI services. You can give the name of a user instead of organization with --user github_user_name.
4. Regenerate the feedstock with conda smithy regenerate ./foo-feedstock
5. Commit the changes cd foo-feedstock && git commit, then push git push upstream master.

Running a build

When everything is configured you can trigger a build with a push to the feedstock repo on github.

Conda-smithy in a nutshell