Metadata-Version: 2.4
Name: datacite
Version: 1.4.1
Summary: A Python client for DataCite MDS and REST APIs.
Project-URL: Repository, https://github.com/inveniosoftware/datacite
Author-email: Invenio Collaboration <info@inveniosoftware.org>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: datacite,doi
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Requires-Dist: idutils>=1.0.0
Requires-Dist: jsonresolver>=0.5.0
Requires-Dist: jsonschema>=3.0.0
Requires-Dist: lxml>=4.5.2
Requires-Dist: requests>=2.12.2
Provides-Extra: all
Requires-Dist: mock>=1.3.0; extra == 'all'
Requires-Dist: pytest-black>=0.6.0; extra == 'all'
Requires-Dist: pytest-invenio>=1.4.0; extra == 'all'
Requires-Dist: responses>=0.10.6; extra == 'all'
Requires-Dist: sphinx>=4.5.0; extra == 'all'
Provides-Extra: docs
Requires-Dist: sphinx>=4.5.0; extra == 'docs'
Provides-Extra: tests
Requires-Dist: mock>=1.3.0; extra == 'tests'
Requires-Dist: pytest-black>=0.6.0; extra == 'tests'
Requires-Dist: pytest-invenio>=1.4.0; extra == 'tests'
Requires-Dist: responses>=0.10.6; extra == 'tests'
Requires-Dist: sphinx>=4.5.0; extra == 'tests'
Description-Content-Type: text/x-rst

==========
 DataCite
==========

.. image:: https://github.com/inveniosoftware/datacite/actions/workflows/tests.yml/badge.svg
        :target: https://github.com/inveniosoftware/datacite/actions/workflows/tests.yml

.. image:: https://img.shields.io/coveralls/inveniosoftware/datacite.svg
   :target: https://coveralls.io/r/inveniosoftware/datacite?branch=master

.. image:: https://img.shields.io/pypi/v/datacite.svg?maxAge=2592000
   :target: https://pypi.python.org/pypi/datacite/

.. image:: https://pepy.tech/badge/datacite?maxAge=2592000
   :target: https://pypi.python.org/pypi/datacite/

.. image:: https://img.shields.io/pypi/l/datacite.svg
   :target: https://github.com/inveniosoftware/datacite/blob/master/LICENSE

.. image:: https://img.shields.io/github/tag/inveniosoftware/datacite.svg
   :target: https://github.com/inveniosoftware/datacite/releases/




About
=====

Python API wrapper for the DataCite REST and Metadata Store APIs as well as 
DataCite JSON and XML generation.

Installation
============
The datacite package is on PyPI so all you need is: ::

    pip install datacite


Documentation
=============

Documentation is readable at http://datacite.readthedocs.io/ or can be
built using Sphinx: ::

    pip install datacite[docs]
    python setup.py build_sphinx


Testing
=======
Running the test suite is as simple as: ::

    pip install -e .[all]
    ./run-tests.sh

If you're using zsh, use this pip command instead:

    pip install -e .'[all]'

Some tests require a DataCite Test Account.  
Set the following environment variables 
$DATACITE_USER, $DATACITE_PW, $DATACITE_PREFIX 
with your account information for doi.test.datacite.org and
run: ::

    ./run-tests-pw.sh
