https://github.com/tobi-weber/foliolib
Okapi/Folio Manager and Python Library
https://github.com/tobi-weber/foliolib
api-client folio library python python3
Last synced: 6 months ago
JSON representation
Okapi/Folio Manager and Python Library
- Host: GitHub
- URL: https://github.com/tobi-weber/foliolib
- Owner: tobi-weber
- License: gpl-3.0
- Created: 2020-10-04T17:28:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T21:15:31.000Z (about 2 years ago)
- Last Synced: 2025-09-28T00:23:09.300Z (9 months ago)
- Topics: api-client, folio, library, python, python3
- Language: Python
- Homepage:
- Size: 32.6 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: COPYING
Awesome Lists containing this project
README
========
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 `_.
The API is generated from the RAML and OAS files from the Folio-Modules.
Documentation can be found at `https://foliolib.readthedocs.io/ `_.
Python packages can be found at `https://pypi.org/project/foliolib/ `_.
Debian packages can be found at `https://github.com/tobi-weber/foliolib/releases/latest/ `_.
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 --host okapi.server.url --port 9130 --admin
Make a Folio-API request:
.. code-block:: python
>>> from foliolib import server
>>> from foliolib.folio.usersImpl import UsersImpl
>>> from foliolib.folio.api.inventory import Inventory
>>>
>>> server("myServer")
>>>
>>> UsersImpl("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