Foliage: a tool to do bulk changes in FOLIO using the OKAPI API
Project description
Foliage
Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes and other operations in FOLIO using the network API.
Table of contents
Introduction
Foliage (Folio change Editor) is a desktop computer application that can perform operations in FOLIO, a library services platform (LSP) used by Caltech and other institutions. Foliage allows a user to look up records of various kinds, perform bulk changes in the values of record fields, delete records, and more. It communicates with a FOLIO server using the OKAPI network API. The program is cross-platform compatible and currently in use on Windows and macOS computers at the Caltech Library.
Although Foliage is a desktop application and not a web service, it uses a web page as its user interface – it opens a page in a browser on the user's computer, letting the user interact with the program through the familiar elements of a web page. This lets Foliage present an identical user interface no matter whether it is running on Window, macOS, or Linux.
Installation
There are multiple ways of installing Foliage, ranging from downloading a self-contained, single-file, ready-to-run program, to installing it as a typical Python program using pip
. Please choose the alternative that suits you.
Alternative 1: installing the ready-to-run executable programs
For the Caltech Library, we provide Foliage in a ready-to-run form for Windows computers. This is the easiest and preferred way of getting a copy of Foliage. Please contact the author for more information.
Alternative 2: installing Foliage using pipx
You can use pipx to install Foliage. Pipx will install it into a separate Python environment that isolates the dependencies needed by Foliage from other Python programs on your system, and yet the resulting foliage
command wil be executable from any shell – like any normal program on your computer. If you do not already have pipx
on your system, it can be installed in a variety of easy ways and it is best to consult Pipx's installation guide for instructions. Once you have pipx on your system, you can install Foliage with the following command:
pipx install foliage
Pipx can also let you run Foliage directly using pipx run foliage
, although in that case, you must always prefix every foliage
command with pipx run
. Consult the documentation for pipx run
for more information.
Alternative 3: installing Foliage using pip
The instructions below assume you have a Python 3 interpreter installed on your computer. Note that the default on macOS at least through 10.14 (Mojave) is Python 2 – please first install Python version 3 and familiarize yourself with running Python programs on your system before proceeding further.
You should be able to install foliage
with pip
for Python 3. To install foliage
from the Python package repository (PyPI), run the following command:
python3 -m pip install foliage
As an alternative to getting it from PyPI, you can use pip
to install foliage
directly from GitHub:
python3 -m pip install git+https://github.com/calitechlibrary/foliage.git
If you already installed Foliage once before, and want to update to the latest version, add --upgrade
to the end of either command line above.
Alternative 4: installing Foliage from sources
If you prefer to install Foliage directly from the source code, you can do that too. To get a copy of the files, you can clone the GitHub repository:
git clone https://github.com/caltechlibrary/foliage
Alternatively, you can download the files as a ZIP archive using this link directly from your browser using this link: https://github.com/caltechlibrary/foliage/archive/refs/heads/main.zip
Next, after getting a copy of the files, run setup.py
inside the code directory:
cd foliage
python3 setup.py install
Usage
Documentation for Foliage is available online at https://caltechlibrary.github.io/foliage/.
Getting help
If you find an issue, please submit it in the GitHub issue tracker for this repository.
Contributing
Your help and participation in enhancing Foliage is welcome! Please visit the guidelines for contributing for some tips on getting started. Developer documentation is available in the repository at dev/dev-docs
.
License
Software produced by the Caltech Library is Copyright © 2021–2022 California Institute of Technology. This software is freely distributed under a BSD type license. Please see the LICENSE file for more information.
Acknowledgments
This work was funded by the California Institute of Technology Library.
The vector artwork used as a starting point for the logo for this repository was created by Alice Noir for the Noun Project. It is licensed under the Creative Commons Attribution 3.0 Unported license. The vector graphics was modified by Mike Hucka to change the color.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.