Welcome to Outpak's documentation!

---

Read the Docs: http://outpak.readthedocs.io/

Source Code: https://github.com/chrismaille/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.

Install Outpak

Install Outpak using the command:

$ pip install outpak

Create the pak.yml file

For a simple example, let's consider the following environment for your project, loaded in the .bashrc file:

$ export MY_ENVIRONMENT="docker"
$ export MY_GIT_TOKEN="12345abcde"

Based on these values, we can create the pak.yml configuration file:

    version: "1"
    github_key: MY_GIT_TOKEN
    env_key: MY_ENVIRONMENT
    envs:
      Docker:
        key_value: docker
        clone_dir: /opt/src
        files:
          - requirements.txt
          - requirements_test.txt

Save this file on same path where is your requirements.txt files are located.

Run Outpak

After create the configuration file, you can start install packages with the command:

$ pak install --config /path/to/pak/file

If you do not inform the path for the pak.yml file, Outpak_ will attempt to find it in the current directory. You can also you can set the OUTPAK_FILE environment variable for where the pak.yml file is located.

Further reading

Please check full documentation in Read the Docs