ltd-mason 0.1.0.dev0

Install for production

Mason is available on PyPI:

pip install ltd-mason

Next, see the Usage section.

Install for development/testing

Once the environment is ready, install Mason from this Git repository via:

git clone https://github.com/lsst-sqre/ltd-mason.git
pip install -r requirements.txt
python setup.py develop

See Testing for information on running unit tests.

YAML Manifest

A YAML-encoded manifest file tells ltd-mason what documentation to build, and where to find individual packages for multi-package LSST Stack-type build. The manifest’s schema is described in SQR-006, and examples are also available here in the tests/ and integration_tests/ directories. Formally the manifest schema is defined in manifest_schema.yaml.

Enviroment Variables and AWS credentials

LTD Mason is configured through environment variables.

Unit tests

Developers can run unit tests via pytest:

py.test

To run a full suite of AWS S3 integration tests, you’ll need AWS credentials and an S3 bucket to test in. Configure the tests to use these by setting the following environment variables:

LTD_MASON_TEST_AWS_ID

AWS access key ID

LTD_MASON_TEST_AWS_SECRET

AWS secret access key

LTD_MASON_TEST_BUCKET

Name of an S3 bucket that already exists and can be used for testing.

Integration tests

We have separate integration tests to exercise code that interacts with AWS S3 and ltd-keeper. See integration_tests/README.rst for instructions on how to run these integration tests.