https://github.com/caltechlibrary/refoliate
REstore FOLIo sAved insTancEs
https://github.com/caltechlibrary/refoliate
folio library-automation library-management
Last synced: 12 months ago
JSON representation
REstore FOLIo sAved insTancEs
- Host: GitHub
- URL: https://github.com/caltechlibrary/refoliate
- Owner: caltechlibrary
- License: other
- Created: 2022-06-30T21:21:16.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-08T01:22:02.000Z (almost 4 years ago)
- Last Synced: 2025-04-13T05:50:04.986Z (about 1 year ago)
- Topics: folio, library-automation, library-management
- Language: Python
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
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
# Refoliate
REstore FOLIo sAved insTancEs.
[](https://github.com/caltechlibrary/refoliate/LICENSE)
[](https://github.com/caltechlibrary/refoliate/releases)
## Table of contents
* [Introduction](#introduction)
* [Installation](#installation)
* [Usage](#usage)
* [Known issues and limitations](#known-issues-and-limitations)
* [Getting help](#getting-help)
* [Contributing](#contributing)
* [License](#license)
* [Acknowledgments](#authors-and-acknowledgments)
## Introduction
This is a command-line program that will take a folder of JSON files (assumed to be instance, holdings and item records previously downloaded from FOLIO) and (re)creates them in FOLIO via the API.
## Usage
```
REstore FOLIo sAved insTancEs.
This program takes a directory of JSON files previously downloaded from FOLIO
by a program such as Foliage. The files are assumed to represent instance,
holdings, and item records that have been deleted from FOLIO. This program
proceeds to put the records back into FOLIO as-is, using the same UUID's
and all other fields.
If given the argument --continue, then errors involving the inability to
create a record (e.g., due to the record already existing in FOLIO) will make
this program continue execution; otherwise, by default, this program will
stop at the first error.
If given the -@ argument (/@ on Windows), this program will output a detailed
trace of what it is doing. The debug trace will be sent to the given
destination, which can be '-' to indicate console output, or a file path to
send the output to a file.
If given the -V option (/V on Windows), this program will print the version
and other information, and exit without doing anything else.
Command-line arguments summary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
positional arguments:
source_dir directory containing JSON files
options:
-h, --help show this help message and exit
-c, --continue continue, don't stop, if an error occurs
-V, --version print version info and exit
-@ OUT, --debug OUT log debug output to "OUT" ("-" is console)
```
## Known issues and limitations
... Forthcoming ...
## Getting help
... Forthcoming ...
## Contributing
... Forthcoming ...
## License
Software produced by the Caltech Library is Copyright © 2022 California Institute of Technology. This software is freely distributed under a BSD-style license. Please see the [LICENSE](LICENSE) file for more information.
## Acknowledgments
This work was funded by the California Institute of Technology Library.
