Skip to content
caltechlibraryPublic

About

Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes in FOLIO using the network API.

Topics

Resources

Code of conduct

Contributing

Stars

11 stars

Watchers

5 watching

Forks

Latest commit

 

History

803 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FoliageFoliage icon

Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes and other operations in FOLIO using the network API.

License Python Latest release

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.

Foliage screenshot

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.

Foliage warning

Installation

Most people should install the ready-to-run application for macOS or Windows. Developers can run Foliage from a copy of the source code.

Alternative 1: installing the macOS or Windows application

Download the installer for your computer from the latest release:

  • macOS: foliage_X.Y.Z_macos_arm64.dmg, for Macs with Apple silicon. Open the DMG and drag Foliage to your Applications folder. The first time you open it, macOS may say it can’t verify the app. If so, go to System Settings → Privacy & Security, and click Open Anyway.
  • Windows: foliage_X.Y.Z_windows_x64.msi. Double-click it to install Foliage. If Windows says it protected your PC, click More info, then Run anyway.

Alternative 2: running Foliage from the source code

This requires Python 3.11 or later. Foliage needs a modified copy of PyWebIO, which has to be installed separately before Foliage:

git clone https://github.com/caltechlibrary/foliage
cd foliage
python3 -m pip install git+https://github.com/mhucka/PyWebIO.git@2af53fc
python3 -m pip install .

Foliage isn’t published on PyPI.

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–2023 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.

About

Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes in FOLIO using the network API.

Topics

Resources

Code of conduct

Contributing

Stars

11 stars

Watchers

5 watching

Forks

Releases

Used by

Contributors

Languages