Skip to content

YAML formatted manifest class with support for multiple checksums per file

Notifications You must be signed in to change notification settings

ACCESS-NRI/yamanifest

Repository files navigation

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 coecms yamanifest

Pip install (into a virtual environment):

pip install yamanifest

Use

Develop

Development install:

git checkout https://github.com/aidanheerdegen/yamanifest
cd yamanifest
conda env create -f conda/dev-environment.yml
source activate yamanifest-dev
pip install -e '.[dev]'

The dev-environment.yml file is for speeding up installs and installing packages unavailable on pypi, requirements.txt is the source of truth for dependencies.

Run tests:

py.test

Build documentation:

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

Upload documentation:

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

About

YAML formatted manifest class with support for multiple checksums per file

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages