.. raw:: html
.. You can adapt this file completely to your liking, but it should at least
.. contain the root `toctree` directive.
.. Custom roles and commands
.. |_| unicode:: U+00A0 .. non-breaking space
.. |manual| image:: _static/img/user-manual.png
.. |python| image:: _static/img/python.png
.. |api| image:: _static/img/api-2.png
.. |plugin| image:: _static/img/plugin.png
.. |package| image:: _static/img/package.png
.. |pipeline| image:: _static/img/pipeline.png
.. |changelog| image:: _static/img/changelog.png
.. |dashboard| image:: _static/img/dashboard.png
.. role:: blue
Welcome to the api-24sea project documentation!
====================================================================================================================================================
.. topic:: Release Prod
Version |release|
**api_24sea** is a project designed to provide aid for the interaction with data
from the `24SEA API `_.
Since the `API `_ returns data in JSON format,
which is not very user-friendly, we have created a package that allows you to
interact with the data in a more efficient way. The package is designed to
perform queries asynchronously through the `httpx `_
library, which allows you to make multiple requests at the same time. Furthermore,
the interaction with the data is facilitated by transforming the output of the
queries into `pandas DataFrames `_
for easy manipulation and analysis.
.. note::
Some pages have been protected with a master password. If you are
interested in accessing them, please contact 24SEA at
`support.api@24sea.eu `_, and we will
see what we can do 😊.
-----------------------
.. grid:: 1 2 3 3
:gutter: 3 3 4 5
.. grid-item-card::
|manual| |_| |_| |_| |_| **Quick start!**
New to api_24sea? Check out the Quick Start guide
+++
.. button-ref:: project/01-intro
:expand:
:color: primary
:click-parent:
To the Quick Start guide
.. grid-item-card::
|plugin| |_| |_| |_| |_| **Package Plugins**
The package plugins allow to extend the package functionalities
by adding new features.
+++
.. button-ref:: project/user-manual/05-plugins
:expand:
:color: primary
:click-parent:
To the plugins installation guide
.. grid-item-card::
|package| |_| |_| |_| |_| **Package Reference**
The package reference documentation contains a detailed code description
of api_24sea.
+++
.. button-ref:: autoapi/index
:expand:
:color: primary
:click-parent:
To the reference guide
.. grid-item-card::
|changelog| |_| |_| |_| |_| **Changelog**
Release notes and changelog for all versions of the package.
+++
.. button-ref:: project/02-changelog
:expand:
:color: primary
:click-parent:
To the changelog
.. grid-item-card::
|python| |_| |_| |_| |_| **Interactive Example**
With the interactive example you can test the package functionalities
directly in the documentation by running Python in the browser.
+++
.. button-ref:: project/03-interactive-example
:expand:
:color: primary
:click-parent:
To the interactive example
.. grid-item-card::
|dashboard| |_| |_| |_| |_| **Dashboard**
A simple web application that allows you to visualize the data retrieved
from the API.
+++
.. button-ref:: project/04-dashboard
:expand:
:color: primary
:click-parent:
To the dashboard
-----------------------
.. toctree::
:hidden:
project/01-intro
project/user-manual/01-intro
dev-guide/01-intro
autoapi/index
project/02-changelog
project/03-interactive-example
project/04-dashboard
examples/index
License
-----------------------
The package is licensed under the `GNU General Public License v3.0 `_.
Miscellaneous Pages
-------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`