Metadata-Version: 1.1
Name: yamanifest
Version: 0.3.0
Summary: General YAML manifest format
Home-page: UNKNOWN
Author: Aidan Heerdegen
Author-email: aidan.heerdegen@anu.edu.au
License: UNKNOWN
Description-Content-Type: UNKNOWN
Description: =============================
        yamanifest
        =============================
        
        General YAML manifest format
        
        .. image:: https://readthedocs.org/projects/yamanifest/badge/?version=latest
          :target: https://readthedocs.org/projects/yamanifest/?badge=latest
        .. image:: https://travis-ci.org/aidanheerdegen/yamanifest.svg?branch=master
          :target: https://travis-ci.org/aidanheerdegen/yamanifest
        .. image:: https://circleci.com/gh/coecms/yamanifest.svg?style=shield
          :target: https://circleci.com/gh/coecms/yamanifest
        .. image:: http://codecov.io/github/aidanheerdegen/yamanifest/coverage.svg?branch=master
          :target: http://codecov.io/github/aidanheerdegen/yamanifest?branch=master
        .. image:: https://badge.fury.io/py/yamanifest.svg
          :target: https://pypi.python.org/pypi/yamanifest
        
        .. content-marker-for-sphinx
        
        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 aidanheerdegen 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
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
