# Foliage<img width="12%" align="right" src="https://github.com/caltechlibrary/foliage/raw/main/.graphics/foliage-icon.png">
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](#authors-and-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.
<p align="center">
<img width="700" src="https://github.com/caltechlibrary/foliage/raw/main/.graphics/foliage-screenshot.png">
</p>
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.
<p align="center"><img width="80%" src="https://github.com/caltechlibrary/foliage/raw/main/.graphics/status-warning.svg"></p>
## 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: <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:
```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.
<div align="center">
<br>
<a href="https://www.caltech.edu">
<img width="100" height="100" src="https://raw.githubusercontent.com/caltechlibrary/foliage/main/.graphics/caltech-round.png">
</a>
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/caltechlibrary/foliage",
"name": "foliage",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "Python,applications",
"author": "Mike Hucka",
"author_email": "helpdesk@library.caltech.edu",
"download_url": "https://files.pythonhosted.org/packages/f9/8f/1eb980ac4e50b32dc419a4368d3bee4c78d3b0eb24816aa9729b70307579/foliage-1.7.2.tar.gz",
"platform": null,
"description": "# Foliage<img width=\"12%\" align=\"right\" src=\"https://github.com/caltechlibrary/foliage/raw/main/.graphics/foliage-icon.png\">\n\nFoliage is the FOLIo chAnGe Editor, a tool to do bulk changes and other operations in FOLIO using the network API.\n\n[](https://choosealicense.com/licenses/bsd-3-clause)\n[](https://www.python.org/downloads/release/python-380/)\n[](https://github.com/caltechlibrary/foliage/releases)\n\n\n## Table of contents\n\n* [Introduction](#introduction)\n* [Installation](#installation)\n* [Usage](#usage)\n* [Getting help](#getting-help)\n* [Contributing](#contributing)\n* [License](#license)\n* [Acknowledgments](#authors-and-acknowledgments)\n\n\n## Introduction\n\nFoliage (_**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.\n\n<p align=\"center\">\n<img width=\"700\" src=\"https://github.com/caltechlibrary/foliage/raw/main/.graphics/foliage-screenshot.png\">\n</p>\n\nAlthough 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.\n\n<p align=\"center\"><img width=\"80%\" src=\"https://github.com/caltechlibrary/foliage/raw/main/.graphics/status-warning.svg\"></p>\n\n\n## Installation\n\nThere 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.\n\n\n### _Alternative 1: installing the ready-to-run executable programs_\n\nFor 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.\n\n\n### _Alternative 2: installing Foliage using `pip`_\n\nThe 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.\n\nYou 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:\n```sh\npython3 -m pip install git+https://github.com/mhucka/PyWebIO.git@2af53fc\npython3 -m pip install foliage\n```\n\n_If you already installed Foliage once before_, and want to update to the latest version, add `--upgrade` to the ends the commands above.\n\n\n### _Alternative 3: installing Foliage from sources_\n\nIf 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:\n```sh\ngit clone https://github.com/caltechlibrary/foliage\n```\n\nAlternatively, 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>\n\nNext, after getting a copy of the files, run `setup.py` inside the code directory:\n```sh\ncd foliage\npython3 -m pip install git+https://github.com/mhucka/PyWebIO.git@2af53fc\npython3 setup.py install\n```\n\n\n## Usage\n\nDocumentation for Foliage is available online at [https://caltechlibrary.github.io/foliage/](https://caltechlibrary.github.io/foliage/).\n\n\n## Getting help\n\nIf you find an issue, please submit it in [the GitHub issue tracker](https://github.com/caltechlibrary/foliage/issues) for this repository.\n\n\n## Contributing\n\nYour 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).\n\n\n## License\n\nSoftware produced by the Caltech Library is Copyright \u00a9 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.\n\n\n## Acknowledgments\n\nThis work was funded by the California Institute of Technology Library.\n\nThe [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.\n\n<div align=\"center\">\n <br>\n <a href=\"https://www.caltech.edu\">\n <img width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/caltechlibrary/foliage/main/.graphics/caltech-round.png\">\n </a>\n</div>\n",
"bugtrack_url": null,
"license": "BSD 3-clause license",
"summary": "Foliage: a tool to do bulk changes in FOLIO using the OKAPI API",
"version": "1.7.2",
"project_urls": {
"Bug Tracker": "https://github.com/caltechlibrary/foliage/issues",
"Homepage": "https://github.com/caltechlibrary/foliage",
"Source Code": "https://github.com/caltechlibrary/foliage"
},
"split_keywords": [
"python",
"applications"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2798cb3a58a7f3dd50bb269f22d4e718efc1a576134cd50be50cbc272105958",
"md5": "c79d7648768d0c2d5250530f2b210ac0",
"sha256": "37234e8c65400cbe1a7767f46e5f108b66162e08955825d06266817537359405"
},
"downloads": -1,
"filename": "foliage-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c79d7648768d0c2d5250530f2b210ac0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 73408,
"upload_time": "2023-10-25T21:20:14",
"upload_time_iso_8601": "2023-10-25T21:20:14.276538Z",
"url": "https://files.pythonhosted.org/packages/f2/79/8cb3a58a7f3dd50bb269f22d4e718efc1a576134cd50be50cbc272105958/foliage-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f98f1eb980ac4e50b32dc419a4368d3bee4c78d3b0eb24816aa9729b70307579",
"md5": "75a9961f1769b1fc01ed9e3679de09cf",
"sha256": "f0b279a68ee1215161b292e17e1b8d76231ff0a9b25a4ae44d440533c042ba65"
},
"downloads": -1,
"filename": "foliage-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "75a9961f1769b1fc01ed9e3679de09cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 65802,
"upload_time": "2023-10-25T21:20:15",
"upload_time_iso_8601": "2023-10-25T21:20:15.805566Z",
"url": "https://files.pythonhosted.org/packages/f9/8f/1eb980ac4e50b32dc419a4368d3bee4c78d3b0eb24816aa9729b70307579/foliage-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 21:20:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "caltechlibrary",
"github_project": "foliage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "foliage"
}
JSON
