Metadata-Version: 2.1
Name: bdbag
Version: 1.3.0
Summary: Big Data Bag Utilities
Home-page: https://github.com/fair-research/bdbag/
Maintainer: USC Information Sciences Institute, Informatics Systems Research Division
Maintainer-email: isrd-support@isi.edu
License: Apache 2.0
Description: # bdbag
        [![Build Status](https://travis-ci.org/fair-research/bdbag.svg)](https://travis-ci.org/fair-research/bdbag)
        [![Coverage Status](https://coveralls.io/repos/github/fair-research/bdbag/badge.svg?branch=master)](https://coveralls.io/github/fair-research/bdbag?branch=master)
        [![PyPi Version](https://img.shields.io/pypi/v/bdbag.svg)](https://pypi.python.org/pypi/bdbag)
        [![PyPi Wheel](https://img.shields.io/pypi/wheel/bdbag.svg)](https://pypi.python.org/pypi/bdbag)
        [![Python Versions](https://img.shields.io/pypi/pyversions/bdbag.svg)](https://pypi.python.org/pypi/bdbag)
        [![License](https://img.shields.io/pypi/l/bdbag.svg)](http://www.apache.org/licenses/LICENSE-2.0)
        
        #### Big Data Bag Utilities
        
        The *bdbag* utilities are a collection of software programs for working with
        [BagIt](https://datatracker.ietf.org/doc/draft-kunze-bagit/) packages that conform to the Bagit and Bagit/RO profiles.
        
        The *bdbag* [profiles](https://github.com/fair-research/bdbag/tree/master/profiles) specify the use of the fetch.txt file, require serialization, and specify what manifests must be provided with a *bdbag*.
        
        These utilities combine various other components such as the
        [Bagit-Python](https://github.com/LibraryOfCongress/bagit-python) bag creation utility and the
        [Bagit-Profiles-Validator](https://github.com/ruebot/bagit-profiles)
        utility into a single, easy to use software package.
        
        Enhanced bag support includes:
        
        * Update-in-place functionality for existing bags.
        * Automatic archiving and extraction of bags using ZIP, TAR, and TGZ formats.
        * Automatic generation of remote file manifest entries and fetch.txt via configuration file.
        * Automatic file retrieval based on the contents of a bag's fetch.txt file with multiple protocol support.
        * Built-in profile validation.
        * Built-in support for creation of bags with [Bagit/RO profile](https://github.com/ResearchObject/bagit-ro) compatibility.
        
        An experimental Graphical User Interface (GUI) for *bdbag* can be found [here](https://github.com/fair-research/bdbag_gui).
        
        #### Technical Papers
        
        ["I'll take that to go: Big data bags and minimal identifiers for exchange of large, complex datasets"](https://zenodo.org/record/820878) explains the motivation for BDBags and the related Minid construct, provides details on design and implementation, and gives examples of use. 
        
        ["Reproducible big data science: A case study in continuous FAIRness"](https://www.biorxiv.org/content/early/2018/02/27/268755) presents a data analysis use case in which BDBags and Minids are used to capture a transcription factor binding site analysis.
        
        ### Dependencies
        
        * [Python 2.7](https://www.python.org/downloads/release/python-27/) is the minimum Python version required.
        * The code and dependencies are also compatible with Python 3, versions 3.3 through 3.6.
        
        ### Installation
        The latest *bdbag* release is available on PyPi and can be installed using `pip`:
        
        ```sh
        pip install bdbag
        ```
        
        ### Installation from Source
        Download the current [bdbag](https://github.com/fair-research/bdbag/archive/master.zip) source code from GitHub or
        alternatively clone the source from GitHub if you have *git* installed:
        
        ```sh
        git clone https://github.com/fair-research/bdbag
        ```
        From the root of the **bdbag** source code directory execute the following command:
        ```sh
        python setup.py install --user
        ```
        
        Note that if you want to make **bdbag** available to all users on the system, you should run the following command:
        ```sh
        python setup.py install
        ```
        If you are on a Unix-based system (including MacOSX) you should execute the above command as **root** or use **sudo**.
        
        ### Testing
        The unit tests can be run by invoking the following command from the root of the **bdbag** source code directory:
        ```sh
        python setup.py test
        ```
        
        ### Usage
        
        This software can be used from the command-line environment by running the **bdbag** script.  For detailed usage
        instructions, see the [CLI guide](./doc/cli.md).
        
        ### Configuration
        
        Some components of the **bdbag** software can be configured via JSON-formatted configuration files.
        See the [Configuration guide](./doc/config.md) for further details.
        
        ### Application Programming Interface
        
        It is also possible to use **bdbag** from within other Python programs via an API.
        See the [API guide](./doc/api.md) for further details.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires: argparse
Requires: os
Requires: sys
Requires: platform
Requires: logging
Requires: time
Requires: datetime
Requires: json
Requires: shutil
Requires: tempfile
Requires: tarfile
Requires: zipfile
Requires: urlparse
Requires: pytz
Requires: tzlocal
Requires: requests
Requires: certifi
Requires: bagit
Description-Content-Type: text/markdown
