Metadata-Version: 1.2
Name: elifetools
Version: 0.5.0
Summary: Tools for using article data in Python.
Home-page: https://github.com/elifesciences/elife-tools
Maintainer: eLife Sciences Publications Ltd.
Maintainer-email: tech-team@elifesciences.org
License: MIT
Description: elife-tools
        ===========
           
        .. image:: https://coveralls.io/repos/elifesciences/elife-tools/badge.svg?branch=master&service=github
           :target: https://coveralls.io/github/elifesciences/elife-tools?branch=master
        
        Tools for using article data in Python
        
        Supports
        ============
        
        * Python >=3.5
        
        Non-Python dependencies
        =======================
        
        * libxml2 (Ubuntu, Arch)
        
        Install for users
        =================
        
        Install via `pip <https://pip.pypa.io/en/stable/>`_:
        
        .. code-block:: bash
        
           $ pip install elifetools
           
        You might need to install libxml manually first
        
        .. code-block:: bash
        
           $ sudo STATIC_DEPS=true pip install lxml==3.4.1
        
        To install the latest version directly from git
        
        .. code-block:: bash
        
           $ pip install git+https://github.com/elifesciences/elife-tools.git@master
        
        or you can add it to your project's requirements.txt file
        
        .. code-block:: bash
        
           git+https://github.com/elifesciences/elife-tools.git@master
        
        
        Install for developers
        ======================
        
        Clone the git repo
        
        Make a virtualenv (optional)
        
        Then
        
        .. code-block:: bash
        
           $ python setup.py install
        
        Example usage
        =============
        
        .. code-block:: python
        
            >>> from elifetools import parseJATS as parser
            >>> soup = parser.parse_document('sample-xml/elife-kitchen-sink.xml')
            >>> print(parser.doi(soup))
        
        More code examples can be found in `tests/basic_usage_test.py`
        
        
        Testing
        =======
        
        You can run the full automated test suite from the base folder with:
        
        .. code-block:: bash
        
            $ python -m unittest discover elifetools/tests
        
        or you can run tests with coverage:
        
        .. code-block:: bash
        
            $ coverage run -m unittest discover elifetools/tests
        
        and then view the coverage report:
        
        .. code-block:: bash
        
            $ coverage report -m
        
        
        License
        =========
        
        `The MIT License <http://opensource.org/licenses/mit-license.php>`_
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
