https://github.com/caltechlibrary/foliage
Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes in FOLIO using the network API.
https://github.com/caltechlibrary/foliage
bulk-operation editor folio folio-lsp
Last synced: 8 months ago
JSON representation
Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes in FOLIO using the network API.
- Host: GitHub
- URL: https://github.com/caltechlibrary/foliage
- Owner: caltechlibrary
- License: other
- Created: 2021-10-16T00:45:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T22:43:20.000Z (about 2 years ago)
- Last Synced: 2025-09-28T00:22:51.203Z (9 months ago)
- Topics: bulk-operation, editor, folio, folio-lsp
- Language: Python
- Homepage: https://caltechlibrary.github.io/foliage
- Size: 22.7 MB
- Stars: 11
- Watchers: 6
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Support: SUPPORT.md
- Codemeta: codemeta.json
Awesome Lists containing this project
README
# Foliage
Foliage is the FOLIo chAnGe Editor, a tool to do bulk changes and other operations in FOLIO using the network API.
[](https://choosealicense.com/licenses/bsd-3-clause)
[](https://www.python.org/downloads/release/python-380/)
[](https://github.com/caltechlibrary/foliage/releases)
## Table of contents
* [Introduction](#introduction)
* [Installation](#installation)
* [Usage](#usage)
* [Getting help](#getting-help)
* [Contributing](#contributing)
* [License](#license)
* [Acknowledgments](#acknowledgments)
## Introduction
Foliage (_**Foli**o ch**a**n**g**e **E**ditor_) is a desktop computer application that can perform operations in [FOLIO](https://www.folio.org), a library services platform ([LSP](https://journals.ala.org/index.php/ltr/article/view/5686/7063)) 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](https://github.com/folio-org/okapi/blob/master/doc/guide.md). 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 `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`](https://pip.pypa.io/en/stable/installing/) for Python 3. To install `foliage` from the [Python package repository (PyPI)](https://pypi.org), run the following **two** commands:
```sh
python3 -m pip install git+https://github.com/mhucka/PyWebIO.git@2af53fc
python3 -m pip install foliage
```
_If you already installed Foliage once before_, and want to update to the latest version, add `--upgrade` to the ends the commands above.
### _Alternative 3: 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:
```sh
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:
Next, after getting a copy of the files, run `setup.py` inside the code directory:
```sh
cd foliage
python3 -m pip install git+https://github.com/mhucka/PyWebIO.git@2af53fc
python3 setup.py install
```
## Usage
Documentation for Foliage is available online at [https://caltechlibrary.github.io/foliage/](https://caltechlibrary.github.io/foliage/).
## Getting help
If you find an issue, please submit it in [the GitHub issue tracker](https://github.com/caltechlibrary/foliage/issues) for this repository.
## Contributing
Your help and participation in enhancing Foliage is welcome! Please visit the [guidelines for contributing](CONTRIBUTING.md) for some tips on getting started. Developer documentation is available in the repository at [`dev/dev-docs`](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](LICENSE) file for more information.
## Acknowledgments
This work was funded by the California Institute of Technology Library.
The [vector artwork](https://thenounproject.com/term/branch/1047074/) used as a starting point for the logo for this repository was created by [Alice Noir](https://thenounproject.com/AliceNoir/) for the [Noun Project](https://thenounproject.com). It is licensed under the Creative Commons [Attribution 3.0 Unported](https://creativecommons.org/licenses/by/3.0/deed.en) license. The vector graphics was modified by Mike Hucka to change the color.
