Metadata-Version: 2.1
Name: foliolib
Version: 0.3.1a1
Summary: Okapi/Folio Manager and Library
Home-page: https://github.com/tobi-weber/foliolib
Author: Tobias Weber
Author-email: tobi-weber@gmx.de
License: GPL-3.0 License
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/x-rst
License-File: COPYING

========
FolioLib
========
|PyPI| |Pythons| |ReadTheDocs|

.. |PyPI| image:: https://img.shields.io/pypi/v/foliolib.svg
   :alt: PyPI version
   :target: https://pypi.org/project/foliolib/

.. |Pythons| image:: https://img.shields.io/pypi/pyversions/foliolib.svg
   :alt: Supported Python versions
   :target: https://pypi.org/project/foliolib/

.. |ReadTheDocs| image:: https://readthedocs.org/projects/foliolib/badge/?version=latest
    :target: https://foliolib.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

FolioLib is an API-Client for `Folio <https://www.folio.org/>`_.
The API is generated from the RAML and OAS files from the Folio-Modules.

Documentation can be found `here <https://foliolib.readthedocs.io/>`_.

Features:

- Python Folio API
- Commandline interface
- Install and manage Folio
- Install and manage Folio on Kubernetes
- Manage multiple Folio servers


Quickstart
==========

The installation requires python 3.6 or higher.

.. code-block:: bash

    pip install foliolib

Define a config for your Folio server:

.. code-block:: bash

    foliolib server create --help


.. code-block:: bash

    foliolib server create myServer -H okapi.server.url -p 9130

Make a Folio-API request:

.. code-block:: python

    >>> from foliolib import server
    >>> from foliolib.folio.users import Users
    >>> from foliolib.folio.api.inventory import Inventory
    >>>
    >>> server("myServer")
    >>>
    >>> Users("TenantId").login("UserId","Password")
    >>> inventory = Inventory("TenantId")
    >>> instances = inventory.get_instances(query="title==*")
    >>> print(instances)

Also foliolib provides a command line interface:

.. code-block:: bash

    foliolib --help
