Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: reorganize #96

Merged
merged 2 commits into from
Oct 17, 2024
Merged

docs: reorganize #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc25bd2
docs: reorganize
tmorrell Jul 4, 2024
1480554
package: remove old authors and maintainers files
tmorrell Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions AUTHORS.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion MAINTAINERS
View file
Open in desktop

This file was deleted.

5 changes: 2 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,8 @@
About
=====

Python API wrapper for the DataCite Metadata Store API and DataCite XML
generation.

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

Installation
============
Expand Down
66 changes: 40 additions & 26 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,18 @@
.. raw:: html

<p style="height:22px; margin:0 0 0 2em; float:right">
<a href="https://travis-ci.org/inveniosoftware/datacite">
<img src="https://img.shields.io/travis/inveniosoftware/datacite.svg"
alt="travis-ci badge"/>
<a href="https://github.com/inveniosoftware/datacite/actions/workflows/tests.yml">
<img src="https://github.com/inveniosoftware/datacite/actions/workflows/tests.yml/badge.svg"
alt="ci badge"/>
</a>
<a href="https://coveralls.io/r/inveniosoftware/datacite">
<a href="https://coveralls.io/r/inveniosoftware/datacite?branch=master">
<img src="https://img.shields.io/coveralls/inveniosoftware/datacite.svg"
alt="coveralls.io badge"/>
</a>
</p>

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

Installation
============
Expand All @@ -31,28 +32,29 @@ The datacite package is on PyPI so all you need is:
Usage
=====

The datacite package implements a Python client for DataCite MDS API and DataCite REST API.
You can find below full usage example of the DataCite MDS client API wrapper. Please see
the `DataCite MDS API documentation <https://support.datacite.org/docs/mds-api-guide>`_
The datacite package implements a Python client for DataCite REST and MDS APIs.

You can find below an usage example of the DataCite REST client API wrapper. Please see
the `DataCite REST API documentation <https://support.datacite.org/docs/api>`_
for further information.

.. literalinclude:: ../tests/example/full.py
.. literalinclude:: ../tests/example/full_rest.py
:language: python
:linenos:

You can find below an usage example of the DataCite REST client API wrapper. Please see
the `DataCite REST API documentation <https://support.datacite.org/docs/api>`_
You can find below full usage example of the DataCite MDS client API wrapper. Please see
the `DataCite MDS API documentation <https://support.datacite.org/docs/mds-api-guide>`_
for further information.

.. literalinclude:: ../tests/example/full_rest.py
.. literalinclude:: ../tests/example/full.py
:language: python
:linenos:

Please see the `DataCite Testing guide <https://support.datacite.org/docs/testing-guide>`_ to
know how to test this client with your test credentials.

Metadata Store API
===================
DataCite API Wrappers
============================

.. automodule:: datacite
:members:
Expand All @@ -63,28 +65,40 @@ Errors
.. automodule:: datacite.errors
:members:

DataCite v3.1 XML generation
============================
DataCite v4.5 Metadata Management
==================================

.. automodule:: datacite.schema31
.. automodule:: datacite.schema45
:members: dump_etree, tostring, validate

DataCite v4.0 XML generation
============================
DataCite v4.3 Metadata Management
==================================

.. automodule:: datacite.schema40
.. automodule:: datacite.schema43
:members: dump_etree, tostring, validate

DataCite v4.1 XML generation
============================
DataCite v4.2 Metadata Management
==================================

.. automodule:: datacite.schema42
:members: dump_etree, tostring, validate

DataCite v4.1 Metadata Management
==================================

.. automodule:: datacite.schema41
:members: dump_etree, tostring, validate

DataCite v4.2 XML generation
============================
DataCite v4.0 Metadata Management
==================================

.. automodule:: datacite.schema42
.. automodule:: datacite.schema40
:members: dump_etree, tostring, validate

DataCite v3.1 Metadata Management
==================================

.. automodule:: datacite.schema31
:members: dump_etree, tostring, validate

.. include:: ../CHANGES.rst
Expand All @@ -102,4 +116,4 @@ License
granted to it by virtue of its status as an Intergovernmental Organization
or submit itself to any jurisdiction.

.. include:: ../AUTHORS.rst
Thank you to all the `contributors <https://github.com/inveniosoftware/datacite/graphs/contributors>`!