Metadata-Version: 1.1
Name: pyelucidate
Version: 0.3.3
Summary: Open Source Python Tools for the Elucidate Annotation Server.
Home-page: https://github.com/digirati-co-uk/pyelucidate
Author: Matt McGrattan
Author-email: matt.mcgrattan@digirati.com
License: MIT
Description: =============================
        PyElucidate
        =============================
        
        .. image:: https://badge.fury.io/py/pyelucidate.png
            :target: http://badge.fury.io/py/pyelucidate
        
        .. image:: https://travis-ci.com/digirati-co-uk/pyelucidate.svg?token=SQeW1amdJpFZbNJ175sQ&branch=master
            :target: https://travis-ci.com/digirati-co-uk/pyelucidate
        
        Open Source Python Tools for the Elucidate Annotation Server.
        
        
        Introduction
        ------------
        
        Simple Python helpers for working with Elucidate_, an Open Annotation and W3C Web Annotation annotation server.
        
        
        .. _Elucidate: https://github.com/dlcs/elucidate-server
        
        Elucidate uses the `W3C Web Annotation Protocol`__ but also has some useful additional service APIs. See Elucidate's
        usage_ documentation for further information.
        
        .. _W3CA:  https://www.w3.org/TR/annotation-protocol/
        __ W3CA_
        .. _usage: https://github.com/dlcs/elucidate-server/blob/master/USAGE.md
        
        
        Full documentation at Readthedocs_.
        
        .. _Readthedocs: https://pyelucidate.readthedocs.io
        
        
        Requirements
        ------------
        
        Python 3.5+
        
        Required python packages are listed in `requirements.txt`.
        
        
        .. include:: installation.rst
        
        
        Usage
        -----
        
        Placeholder
        
        
        .. include:: CONTRIBUTING.rst
        
        
        PyElucidate uses Python 3.x. No backwards compatibility with Python 2.x is provided.
        
        Feel free to raise Github issues.
        
        If you find an issue you are interested in fixing you can:
        
        
        * make sure the issue is small and atomic
        * Fork the repository
        * Clone the repository to your local machine
        * Create a new branch for your fix using `git checkout -b branch-name-here`.
        * Fix the issue.
        * Commit and push the code to your remote repository.
        * Submit a pull request to the `pyelucidate` repository, with a description of your fix and the issue number.
        * The PR will be reviewed by the maintainer_ and either merge the PR or response with comments.
        
        .. _maintainer: http://github.com/mattmcgrattan
        
        License
        -------
        
        MIT License
        
        Copyright Digirati Ltd. (c) 2018
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        
        Documentation
        -------------
        
        The full documentation is at https://pyelucidate.readthedocs.io.
        
        
        
        History
        -------
        
        0.1.0 (2018-10-12)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: pyelucidate
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: PyPy
