Get Started Tutorial (sources)

Contains source code and Shell scripts to generate and deploy example DVC repositories used in the Get Started and other sections of the DVC docs.

Requirements

Please make sure you have these available on the environment where these scripts will run:

• Git
• Python 3 (with python3 and pip commands)
• Virtualenv

Scripts

Each example DVC project is in each of the root directories (below). cd into the directory first before running the desired script, for example:

$ cd example-get-started
$ ./deploy.sh

NOTE: For the time being example-get-started is the only project managed here.

example-get-started

• deploy.sh: Makes and deploys code archive from example-get-started/code (downloaded as part of the generate.sh) to S3.

  Requires AWS CLI and write access to s3://dvc-public/code/get-started/.

• generate.sh: Generates the example-get-started DVC project from scratch. A source code archive is downloaded from S3 the same way as in Connect Code and Data.

  If you change the source code files in this repo, run deploy.sh first, to make sure that the code.zip archive is up to date.