Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.56 KB

README.rst

File metadata and controls

63 lines (43 loc) · 1.56 KB

yamanifest

General YAML manifest format

https://readthedocs.org/projects/yamanifest/badge/?version=latest https://travis-ci.org/aidanheerdegen/yamanifest.svg?branch=master https://circleci.com/gh/coecms/yamanifest.svg?style=shield http://codecov.io/github/aidanheerdegen/yamanifest/coverage.svg?branch=master

Python package to generate YaML formatted manifests. This means multiple checksums can be stored for each file, allowing cheap checksum operations to cascade to more expensive hashes if required.

Install

Conda install:

conda install -c access-nri yamanifest

Pip install (into a virtual environment):

pip install yamanifest

Use

Develop

Development install:

git checkout https://github.com/ACCESS-NRI/yamanifest
cd yamanifest
conda env create -f .conda/env_dev.yml
source activate yamanifest-dev

Run tests:

python -m pytest -s

Build documentation:

python setup.py build_sphinx
firefox docs/_build/index.html

Upload documentation:

git subtree push --prefix docs/_build/html/ origin gh-pages