Data

Tools

Indexes

Applications

Experiments

Open Source Science

foliage

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

https://github.com/caltechlibrary/foliage

Science Score: 62.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization caltechlibrary has institutional domain (www.library.caltech.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

bulk-operation editor folio folio-lsp
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 11
  • Watchers: 6
  • Forks: 2
  • Open Issues: 5
  • Releases: 28
Topics
bulk-operation editor folio folio-lsp
Created over 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support Codemeta

README.md

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

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 for Python 3. To install foliage from the Python package repository (PyPI), 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/.

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.


Caltech logo

Owner

  • Name: Caltech Library
  • Login: caltechlibrary
  • Kind: organization
  • Email: helpdesk@library.caltech.edu
  • Location: Pasadena, CA 91125

We manage the physical and digital holdings of the California Institute of Technology, provide services and training, and develop open-source software.

Citation (CITATION.cff) 

cff-version: 1.2
message: "If you use this software, please cite it using these metadata."
title: "Foliage"
authors: 
  -
    affiliation: "Caltech Library"
    given-names: Mike
    family-names: Hucka
    orcid: "0000-0001-9105-5960"
version: "1.8.0"
abstract: "Foliage (FOLIo chAnGe Editor): a tool to do bulk changes in FOLIO using the OKAPI API"
repository-code: "https://github.com/caltechlibrary/foliage"
type: software
license-url: "https://github.com/caltechlibrary/foliage/blob/main/LICENSE"
keywords: 
  - FOLIO
  - batch operations
  - desktop software
date-released: 2024-06-07

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "description": "Foliage: a tool to do bulk changes in FOLIO using the OKAPI API",
  "name": "foliage",
  "codeRepository": "https://github.com/caltechlibrary/foliage",
  "issueTracker": "https://github.com/caltechlibrary/foliage/issues",
  "license": "https://github.com/caltechlibrary/foliage/blob/main/LICENSE",
  "version": "1.8.0",
  "author": [
    {
      "@type": "Person",
      "givenName": "Mike",
      "familyName": "Hucka",
      "affiliation": "California Institute of Technology Library",
      "email": "mhucka@library.caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    }
  ],
  "developmentStatus": "active",
  "downloadUrl": "https://github.com/caltechlibrary/foliage/archive/main.zip",
  "keywords": [
    "software",
    "science"
  ],
  "maintainer": "https://orcid.org/0000-0001-9105-5960",
  "funder": {
    "@id": "https://doi.org/10.13039/100006961",
    "@type": "Organization",
    "name": "Caltech Library"
  }
}

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 699
  • Total Committers: 2
  • Avg Commits per committer: 349.5
  • Development Distribution Score (DDS): 0.001
Top Committers
Name Email Commits
mhucka m****a@c****u 698
mhucka m****a@u****m 1
Committer Domains (Top 20 + Academic)
caltech.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.8
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mhucka (4)
  • rvhewitt (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 84 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 19
  • Total maintainers: 1
pypi.org: foliage

Foliage: a tool to do bulk changes in FOLIO using the OKAPI API

  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 84 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 16.8%
Average: 17.1%
Stargazers count: 17.7%
Downloads: 19.4%
Dependent repos count: 21.6%
Maintainers (1)
mhucka
Last synced: 6 months ago

Dependencies

.github/workflows/archive-github-pages.yml actions
  • caltechlibrary/waystation main composite
.github/workflows/build-sphinx.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3 composite
foliage/data/macos-systray-widget/go.mod go
  • github.com/getlantern/context v0.0.0-20190109183933-c447772a6520
  • github.com/getlantern/errors v0.0.0-20190325191628-abdb3e3e36f7
  • github.com/getlantern/golog v0.0.0-20190830074920-4ef2e798c2d7
  • github.com/getlantern/hex v0.0.0-20190417191902-c6586a6fe0b7
  • github.com/getlantern/hidden v0.0.0-20190325191715-f02dbb02be55
  • github.com/getlantern/ops v0.0.0-20190325191751-d70cb0d6f85f
  • github.com/getlantern/systray v1.1.0
  • github.com/go-stack/stack v1.8.0
  • github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c
  • golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9
foliage/data/macos-systray-widget/go.sum go
  • github.com/davecgh/go-spew v1.1.0
  • github.com/getlantern/context v0.0.0-20190109183933-c447772a6520
  • github.com/getlantern/errors v0.0.0-20190325191628-abdb3e3e36f7
  • github.com/getlantern/golog v0.0.0-20190830074920-4ef2e798c2d7
  • github.com/getlantern/hex v0.0.0-20190417191902-c6586a6fe0b7
  • github.com/getlantern/hidden v0.0.0-20190325191715-f02dbb02be55
  • github.com/getlantern/ops v0.0.0-20190325191751-d70cb0d6f85f
  • github.com/getlantern/systray v1.1.0
  • github.com/go-stack/stack v1.8.0
  • github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c
  • github.com/pmezard/go-difflib v1.0.0
  • github.com/stretchr/objx v0.1.0
  • github.com/stretchr/testify v1.3.0
  • golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9
requirements-dev.txt pypi
  • flake8 >=4.0.1 development
  • flake8-bugbear >=22.4.25 development
  • flake8-builtins >=1.5.3 development
  • flake8-comprehensions >=3.8.0 development
  • flake8-executable >=2.1.1 development
  • flake8-pie >=0.15.0 development
  • flake8-simplify >=0.19.2 development
  • flake8_implicit_str_concat >=0.3.0 development
  • linkify-it-py * development
  • myst-parser * development
  • pytest >=6.2.5 development
  • pytest-cov >=3.0.0 development
  • pytest-mock >=3.7.0 development
  • sphinx-material * development
  • sphinxcontrib-mermaid * development
requirements.txt pypi
  • PyQt5 ==5.15.6
  • appdirs ==1.4.4
  • boltons ==21.0.0
  • commonpy ==1.9.5
  • fastnumbers ==3.1.0
  • keyring ==23.2.1
  • openpyxl ==3.0.7
  • plac ==1.3.4
  • pyperclip ==1.8.2
  • python-decouple ==3.5
  • python-slugify ==4.0.1
  • python_dateutil ==2.8.2
  • rich >=12.0.1
  • setuptools ==58.3.0
  • sidetrack >=2.0.1
  • tornado ==6.1
  • validators ==0.18.2
  • wand ==0.6.7