datafs 0.6.6
DataFS is an abstraction layer for data storage systems. It manages file versions and metadata using a json-like storage system like AWS's DynamoDB and relies on PyFilesystem to abstract file storage, allowing you to store files locally and on the cloud in a seamless interface.
License: MIT license
Keywords: datafs

=========================================
DataFS Data Management System
=========================================

.. image:: https://img.shields.io/pypi/v/datafs.svg
        :target: https://pypi.python.org/pypi/datafs

.. image:: https://travis-ci.org/ClimateImpactLab/DataFS.svg?branch=master
        :target: https://travis-ci.org/ClimateImpactLab/DataFS?branch=master

.. image:: https://coveralls.io/repos/github/ClimateImpactLab/DataFS/badge.svg?branch=master
        :target: https://coveralls.io/github/ClimateImpactLab/DataFS?branch=master

.. image:: https://readthedocs.org/projects/datafs/badge/?version=latest
        :target: https://datafs.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/climateimpactlab/datafs/shield.svg
        :target: https://pyup.io/repos/github/climateimpactlab/datafs/
        :alt: Updates

.. image:: https://api.codacy.com/project/badge/Grade/5e095453424840e092e71c42b8ad8b52
        :alt: Codacy Badge
        :target: https://www.codacy.com/app/delgadom/DataFS?utm_source=github.com&utm_medium=referral&utm_content=ClimateImpactLab/DataFS&utm_campaign=badger


DataFS is a package manager for data. It manages file versions, dependencies, and metadata for individual use or large organizations.

Configure and connect to a metadata `Manager <http://datafs.readthedocs.io/en/latest/configure.manager.html>`_ and multiple data `Services <http://datafs.readthedocs.io/en/latest/configure.authorities.html>`_ using a specification file and you'll be sharing, tracking, and using your data in seconds.


* Free software: MIT license
* Documentation: https://datafs.readthedocs.io.


Features
--------

* Explicit version and metadata management for teams
* Unified read/write interface across file systems
* Easily create out-of-the-box configuration files for users
* Track data dependencies and usage logs
* Use datafs from python or from the command line
* Permissions handled by managers & services, giving you control over user access


Usage
-----

First, `configure an API <http://datafs.readthedocs.io/en/latest/configure.html>`_. Don't worry. It's not too bad. Check out the `quickstart <http://datafs.readthedocs.io/en/latest/quickstart.yml>`_ to follow along.

We'll assume we already have an API object created and attached to a service called "local". Once you have this, you can start using DataFS to create and use archives.

.. code-block:: bash

    $ datafs create my_new_data_archive --description "a test archive"
    created versioned archive <DataArchive local://my_new_data_archive>
    
    $ echo "initial file contents" > my_file.txt
    
    $ datafs update my_new_data_archive my_file.txt
    
    $ datafs cat my_new_data_archive
    initial file contents

Versions are tracked explicitly. Bump versions on write, and read old versions 
if desired.

.. code-block:: bash

    $ echo "updated contents" > my_file.txt
    
    $ datafs update my_new_data_archive my_file.txt --bumpversion minor
    uploaded data to <DataArchive local://my_new_data_archive>. version bumped 0.0.1 --> 0.1.
    
    $ datafs cat my_new_data_archive
    updated contents
    
    $ datafs cat my_new_data_archive --version 0.0.1
    initial file contents

Pin versions using a requirements file to set the default version

.. code-block:: bash

    $ echo "my_new_data_archive==0.0.1" > requirements_data.txt
    
    $ datafs cat my_new_data_archive
    initial file contents

All of these features are available from (and faster in) python:

.. code-block:: python

    >>> import datafs
    >>> api = datafs.get_api()
    >>> archive = api.get_archive('my_new_data_archive')
    >>> with archive.open('r', version='latest') as f:
    ...     print(f.read())
    ...
    updated contents


If you have permission to delete archives, it's easy to do. See `administrative tools <http://datafs.readthedocs.io/en/latest/admin.html>`_ for tips on setting permissions.

.. code-block:: bash

    $ datafs delete my_new_data_archive
    deleted archive <DataArchive local://my_new_data_archive>

See `examples <http://datafs.readthedocs.io/en/latest/examples.html>`_ for more extensive use cases.



Installation
------------

``pip install datafs``


Additionally, you'll need a manager and services:

Managers:

* MongoDB: ``pip install pymongo``
* DynamoDB: ``pip install boto3``

Services:

* Ready out-of-the-box:

  - local
  - shared
  - mounted
  - zip
  - ftp
  - http/https
  - in-memory

* Requiring additional packages:

  - AWS/S3: ``pip install boto``
  - SFTP: ``pip install paramiko``
  - XMLRPC: ``pip install xmlrpclib``


Requirements
------------

For now, DataFS requires python 2.7. We're working on 3x support.


Todo
----

See `issues <https://github.com/ClimateImpactLab/DataFS/issues>`_ to see and add to our todos.


Credits
---------

This package was created by `Justin Simcock <https://github.com/jgerardsimcock>`_ and `Michael Delgado <https://github.com/delgadom>`_ of the `Climate Impact Lab <http://impactlab.org>`_. Check us out on `github <https://github.com/ClimateImpactLab>`_.

Major kudos to the folks at `PyFilesystem <https://github.com/PyFilesystem>`_. Thanks also to `audreyr <https://github.com/audreyr>`_ for the wonderful `cookiecutter <https://github.com/audreyr/cookiecutter-pypackage>`_ package, and to `Pyup <https://pyup.io>`_, a constant source of inspiration and our silent third contributor.


=======
History
=======

0.1.0 (2016-11-18)
------------------

* First release on PyPI.