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 1 committers (100.0%) from academic institutions -
✓Institutional organization owner
Organization caltechlibrary has institutional domain (www.library.caltech.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.0%) to scientific vocabulary
Keywords
Repository
REstore FOLIo sAved insTancEs
Basic Info
Statistics
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
- Releases: 1
Topics
Metadata Files
README.md
Refoliate
REstore FOLIo sAved insTancEs.
Table of contents
- Introduction
- Installation
- Usage
- Known issues and limitations
- Getting help
- Contributing
- License
- 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 file for more information.
Acknowledgments
This work was funded by the California Institute of Technology Library.
Owner
- Name: Caltech Library
- Login: caltechlibrary
- Kind: organization
- Email: helpdesk@library.caltech.edu
- Location: Pasadena, CA 91125
- Website: https://www.library.caltech.edu/
- Repositories: 84
- Profile: https://github.com/caltechlibrary
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: "refoliate"
authors:
- family-names: Hucka
given-names: Mike
affiliation: "Caltech Library"
orcid: "https://orid.org/0000-0001-9105-5960"
version: "0.0.1"
abstract: "REstore FOLIo sAved insTance rEcords"
repository-code: "https://github.com/caltechlibrary/refoliate"
date-released: "RELEASE-DATE"
url: "https://github.com/caltechlibrary/refoliate"
keywords:
- FOLIO
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"description": "REstore FOLIo sAved insTance rEcords",
"name": "refoliate",
"codeRepository": "https://github.com/caltechlibrary/refoliate",
"issueTracker": "https://github.com/caltechlibrary/refoliate/issues",
"license": "https://github.com/caltechlibrary/refoliate/blob/main/LICENSE",
"version": "0.0.1",
"author": [
{
"@type": "Person",
"givenName": "Mike",
"familyName": "Hucka",
"affiliation": "California Institute of Technology Library",
"email": "EMAIL",
"@id": "https://orcid.org/YOUR-ORCID"
}
],
"developmentStatus": "active",
"downloadUrl": "https://github.com/caltechlibrary/refoliate/archive/main.zip",
"keywords": [
"software",
"science"
],
"maintainer": "https://orcid.org/YOUR-ORCID",
"funder": {
"@id": "https://doi.org/10.13039/100006961",
"@type": "Organization",
"name": "Caltech Library"
}
}GitHub Events
Total
Last Year
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| mhucka | m****a@c****u | 18 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- flake8 >=4.0.1
- flake8-bugbear >=22.4.25
- flake8-builtins >=1.5.3
- flake8-comprehensions >=3.8.0
- flake8-executable >=2.1.1
- flake8-pie >=0.15.0
- flake8-simplify >=0.19.2
- flake8_implicit_str_concat >=0.3.0
- pytest >=6.2.5
- pytest-cov >=3.0.0
- pytest-mock >=3.7.0
- boltons *
- commonpy *
- decouple *
- plac *
- rich *
- sidetrack *
- validators *