External Package Dependencies

Definition

Every language that Shipyard supports has packages that can be installed to enhance the functionality and simplicity of your scripts. If your script uses an external package, you'll have to tell Shipyard what packages to install before running the script.

How you enter this information varies by language.

Python

The Python Code Blueprint comes with pip version 19.0.3 pre-installed, allowing you to easily install python package dependencies. In order for your Vessel to run successfully, you must provide a way to install these packages. There are 2 options in the platform for installing Python packages.

Packages Module

On the Requirements tab of every Vessel, the right-hand side contains a module for installing packages. Packages should be formatted with the Package Name field filled out. Optionally, you can include a version for each package name that you've listed. Versions must be formatted according to Python standards.

Uploading requirements.txt

You can also install package dependencies by including a requirements.txt file in the root directory of the code you upload. For more information on how requirements.txt should be formatted, read this guide.

In order to install public packages from GitHub (that are not available on PyPA, or for different versions) you will need to use the git+git scheme with the GitHub URL.

git+git://github.com/Apache/Airflow@master#egg=airflow

Tips: If you're uploading code directly to Shipyard, we recommend installing packages using the Packages Module so that team members can quickly view and change the version.

If you're using a Git connection, we recommend including a requirements.txt file in the root directory. Shipyard will automatically find this file and install dependencies.

Bash

The Bash Code Blueprints run inside Docker containers running a Debian image. Commands required in your Bash scripts come from Linux packages.

If you are writing Bash on your own machine, then you likely already know what commands are required from external dependencies. Those package names go in the Packages module located on the Define Requirements tab.

Here is the site to find all available packages you can use with Bash in Shipyard.

Screenshots

Python Packages