Python package for getting basic data from a FOLIO ILS server
Project description
Pokapi
Pokapi (Python Okapi Interface) is a Python package for getting basic data from using the Okapi API of a FOLIO ILS server.
Table of contents
- Introduction
- Installation
- Usage
- Known issues and limitations
- Getting help
- Contributing
- License
- Authors and history
- Acknowledgments
Introduction
The FOLIO platform is an integrated library system. The Caltech Library uses a hosted solution by EBSCO for its library catalog. To make writing interfaces and automation scripts in Python easier, the Caltech Library Digital Library Development team developed Pokapi (Python Okapi Interface, a Python package that provides an object-oriented interface to accessing in a FOLIO instance via the Okapi API.
Installation
The instructions below assume you have a Python interpreter installed on your computer; if that's not the case, please first install Python version 3 and familiarize yourself with running Python programs on your system.
On Linux, macOS, and Windows operating systems, you should be able to install pokapi
with pip
. To install pokapi
from the Python package repository (PyPI), run the following command:
python3 -m pip install pokapi
As an alternative to getting it from PyPI, you can use pip
to install pokapi
directly from GitHub, like this:
python3 -m pip install git+https://github.com/caltechlibrary/pokapi.git
Usage
... forthcoming ...
Known issues and limitations
... forthcoming ...
Getting help
If you find an issue, please submit it in the GitHub issue tracker for this repository.
Contributing
We would be happy to receive your help and participation with enhancing Topi! Please visit the guidelines for contributing for some tips on getting started.
License
Software produced by the Caltech Library is Copyright © 2021 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the LICENSE file for more information.
Acknowledgments
This work was funded by the California Institute of Technology Library.
Pokapi makes use of numerous open-source packages, without which Pokapi could not have been developed. I want to acknowledge this debt. In alphabetical order, the packages are:
- commonpy – a collection of commonly-useful Python functions
- ipdb – the IPython debugger
- setuptools – library for
setup.py
- sidetrack – simple debug logging/tracing package
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.