Metadata-Version: 2.0
Name: eulcommon
Version: 0.19.0
Summary: A collection of small python utilities for working with binary files and Django
Home-page: https://github.com/emory-libraries/eulcommon
Author: Emory University Libraries
Author-email: libsysdev-l@listserv.cc.emory.edu
License: Apache License, Version 2.0
Keywords: Binary data
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: mimeparse
Requires-Dist: python-magic
Requires-Dist: celery
Provides-Extra: dev
Requires-Dist: mock; extra == 'dev'
Requires-Dist: ply; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-django; extra == 'dev'
Requires-Dist: django-celery; extra == 'dev'
Requires-Dist: django (<1.9); extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Provides-Extra: test
Requires-Dist: mock; extra == 'test'
Requires-Dist: ply; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Requires-Dist: django-celery; extra == 'test'

EULcommon
=========

**package**
  .. image:: https://img.shields.io/pypi/v/eulcommon.svg
     :target: https://pypi.python.org/pypi/eulcommon

  .. image:: https://img.shields.io/github/license/emory-libraries/eulcommon.svg

  .. image:: https://img.shields.io/pypi/dm/eulcommon.svg

**documentation**
  .. image:: https://readthedocs.org/projects/eulcommon/badge/?version=master
    :target: http://eulcommon.readthedocs.io
    :alt: Documentation Status

**code**
  .. image:: https://travis-ci.org/emory-libraries/eulcommon.svg?branch=master
     :target: https://travis-ci.org/emory-libraries/eulcommon
     :alt: Travis-CI Build

  .. image:: https://coveralls.io/repos/github/emory-libraries/eulcommon/badge.svg?branch=master
     :target: https://coveralls.io/github/emory-libraries/eulcommon?branch=master
     :alt: Code Coverage

  .. image:: https://landscape.io/github/emory-libraries/eulcommon/master/landscape.svg?style=flat
     :target: https://landscape.io/github/emory-libraries/eulcommon/master
     :alt: Code Health

  .. image:: https://requires.io/github/emory-libraries/eulcommon/requirements.svg?branch=master
     :target: https://requires.io/github/emory-libraries/eulcommon/requirements/?branch=master
     :alt: Requirements Status

EULcommon is a `Python <http://www.python.org/>`_ module with a few
small utilities that might be useful to others, but were not large or
significant enough to warrant splitting out into their own
repositories at this time.  These components may be broken out at a
later date.

**eulcommon.binfile** provides the capability to map arbitrary binary
data into a read-only python object.

**eulcommon.djangoextras** consists of a small number of extensions
and add-ons for use with `Django <https://www.djangoproject.com/>`_,
such as custom auth decorators, additional form fields, and additional
HTTP responses.


Contact Information
-------------------

**eulcommon** was created by the Digital Programs and Systems Software
Team of `Emory University Libraries <http://web.library.emory.edu/>`_.

libsysdev-l@listserv.cc.emory.edu


License
-------
**eulcommon** is distributed under the Apache 2.0 License.


Developer Notes
---------------

To install dependencies for your local check out of the code, run ``pip install``
in the ``eulcommon`` directory (the use of `virtualenv`_ is recommended)::

    pip install -e .

.. _virtualenv: http://www.virtualenv.org/en/latest/

If you want to run unit tests or build sphinx documentation, you should also
install development dependencies::

    pip install -e . "eulfedora[dev]"

Unit Tests
^^^^^^^^^^

Unit tests can be run with ``py.test``, and include options for
generating xml and coverage reports for continuous integration::

    py.test --junitxml=unittests.xml --cov=eulcommon

Development History
-------------------

For instructions on how to see and interact with the full development
history of **eulcommon**, see
`eulcore-history <https://github.com/emory-libraries/eulcore-history>`_.


