Welcome to Outpak’s documentation!

https://img.shields.io/pypi/v/outpak.svg https://travis-ci.org/chrismaille/outpak.svg?branch=master https://img.shields.io/pypi/pyversions/outpak.svg https://coveralls.io/repos/github/chrismaille/outpak/badge.svg?branch=master Documentation Status https://api.codacy.com/project/badge/Grade/752016eb6b864a01af676a2c9548090b:target:https://www.codacy.com/app/chrismaille/outpak?utm_source=github.com&utm_medium=referral&utm_content=chrismaille/outpak&utm_campaign=Badge_Grade Maintainability Requirements Status

This document will guide you how to install, configure and use Outpak in your projects.

What is Outpak?

Outpak is a tool for installing packages inside requirements.txt using Git Personal Tokens or Bitbucket App Passwords, instead of using SSH keys. This is specially important on Docker projects, if you don’t want to copy the SSH keys inside the containers.

For example, if you have on requirements.txt the following lines:

-e git+git@git.myproject.org:MyProject#egg=MyProject
-e git://git.myproject.org/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709#egg=MyProject

Outpak will:

  1. Parse the urls:

    from: git+git@git.myproject.org:MyProject or git://git.myproject.org/MyProject.git
    to: https://git.myproject.org/myproject
  2. Clone the repositories using the token/password and directory informed in pak.yml file:

    $ git clone https://my_git_token@git.myproject.org/myproject /tmp/myproject
  3. Run git reset to correct commit if informed:

    $ cd /tmp/myproject && git reset --hard da39a3ee5e6b4b0d3255bfef95601890afd80709
  4. And installing package using the``pip install -e .`` command:

    $ cd /tmp/myproject && pip install -e .


Outpak are tested for Bitbucket and Github services. For other DVCS services please check our issues page on github.

Indices and tables