https://github.com/mhucka/zoinks
Command-line utility to return Zotero record field values given a Zotero select link, an item key, or even just a file attachment
https://github.com/mhucka/zoinks
bibliographic-references metadata zotero zotero-api zotero-link
Last synced: about 1 year ago
JSON representation
Command-line utility to return Zotero record field values given a Zotero select link, an item key, or even just a file attachment
- Host: GitHub
- URL: https://github.com/mhucka/zoinks
- Owner: mhucka
- License: other
- Created: 2020-12-15T17:24:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T00:51:27.000Z (over 2 years ago)
- Last Synced: 2025-04-14T03:12:23.378Z (about 1 year ago)
- Topics: bibliographic-references, metadata, zotero, zotero-api, zotero-link
- Language: Python
- Homepage:
- Size: 108 KB
- Stars: 10
- Watchers: 2
- 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
Zoinks
======
Zoinks (_**Zo**tero **in**formation quic**k** **s**earch_) is a command-line utility that returns the values of selected fields of a bibliographic record given a Zotero select link, an item key, or even the path to a file attachment in your Zotero database.
[](https://choosealicense.com/licenses/bsd-3-clause)
[](https://github.com/mhucka/zoinks/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
------------
> "Shaggy has a characteristic speech pattern, marked by his frequent use of the filler word "like" and, when startled, his exclamations of "**Zoinks**!" — _from the Wikipedia entry for [Shaggy Rogers](https://en.wikipedia.org/wiki/Shaggy_Rogers), retrieved on 2020-12-15. An [archived copy](https://web.archive.org/web/20201112011139/https://en.wikipedia.org/wiki/Shaggy_Rogers) is available in the Wayback Machine._
When using [Zotero](https://zotero.org) in scripts and other software, you may need a way to retrieve information about bibliographic entries without searching for them in Zotero itself. _Zoinks_ (a loose acronym for _**Zo**tero **in**formation quic**k **s**earch_) is a program that lets you do this from the command line.
Zoinks is a companion to [Zowie](https://github.com/mhucka/zowie), a command-line application that writes Zotero select links into PDF files to make them accessible outside of Zotero.
Installation
------------
[... forthcoming ...]
Usage
-----
[... forthcoming ...]
Known issues and limitations
----------------------------
[... forthcoming ...]
Getting help
------------
If you find an issue, please submit it in [the GitHub issue tracker](https://github.com/mhucka/zoinks/issues) for this repository.
Contributing
------------
I would be happy to receive your help and participation if you are interested. Everyone is asked to read and respect the [code of conduct](CONDUCT.md) when participating in this project. Development generally takes place on the `development` branch.
License
-------
This software is Copyright (C) 2022–2023, by Michael Hucka and the California Institute of Technology (Pasadena, California, USA). This software is freely distributed under a 3-clause BSD type license. Please see the [LICENSE](LICENSE) file for more information.
Acknowledgments
---------------
This work is a personal project developed by the author, using computing facilities and other resources of the [California Institute of Technology Library](https://www.library.caltech.edu).
The [vector artwork](https://thenounproject.com/term/surprise/2696259/) of a surprised person, used as the icon for this repository, was created by [Adrien Coquet](https://thenounproject.com/coquet_adrien/) from the Noun Project. It is licensed under the Creative Commons [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/) license.