Metadata-Version: 2.0
Name: labpack
Version: 0.10
Summary: UNKNOWN
Home-page: https://github.com/collectiveacuity/labPack
Author: rcj1492
Author-email: support@collectiveacuity.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: PyJWT (>=1.4.2)
Requires-Dist: jsonmodel
Requires-Dist: python-dateutil (>=2.4.2)
Requires-Dist: pytz (>=2015.7)
Requires-Dist: pyyaml (>=3.12)
Requires-Dist: requests
Requires-Dist: tzlocal (>=1.2)

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

=======
labPack
=======
*A Collection of Methods for Data Collection & Processing*

:Downloads: http://pypi.python.org/pypi/labPack
:Source: https://github.com/collectiveacuity/labPack
:Documentation: https://collectiveacuity.github.io/labPack/

============
Introduction
============
Lab Pack is designed to make the process of retrieving, managing and processing data more uniform across a variety of different sources and structures. The classes and methods in this module aggregate and curate python resources and online APIs to provide a set of best practices for handling data across laboratory projects.

============
Installation
============
>From PyPi::

    $ pip install labpack

>From GitHub::

    $ git clone https://github.com/collectiveacuity/labpack
    $ cd labPack
    $ python setup.py install


Getting Started
---------------
This module contains a variety of classes, clients and packages for use in laboratory projects. For example to store records in an indexed file store on the local device, you can use the following methods:

Create an unique ID for records::

    from labpack.records.id import labID

    id = labID()
    url_safe_id_string = id.id48
    id_datetime = id.epoch
    id_mac_address = id.mac

Save record data in local user data::

    from labpack.storage.appdata import appdataClient

    msg_key = '%s/%s.yaml' % (id_mac_address, id_datetime)
    msg_details = { 'dt': id_datetime, 'mac': id_mac_address, 'msg': 'Text me back' }
    msg_client = appdataClient('Outgoing', 'My Team', 'My App')
    mgs_client.create(msg_key, msg_details)


Further Reading
---------------
For more details about how to use labPack, refer to the
`Reference Documentation on GitHub
<https://collectiveacuity.github.io/labPack>`_

