Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Science Score: 44.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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary

Keywords

bibliographic-references metadata zotero zotero-api zotero-link
Last synced: 6 months ago · JSON representation ·

Repository

Command-line utility to return Zotero record field values given a Zotero select link, an item key, or even just a file attachment

Basic Info
  • Host: GitHub
  • Owner: mhucka
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 108 KB
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 8
Topics
bibliographic-references metadata zotero zotero-api zotero-link
Created about 5 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Support Codemeta

README.md

Zoinks

Zoinks (Zotero information quick search) 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.

License Latest release

Table of contents

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, retrieved on 2020-12-15. An archived copy is available in the Wayback Machine.

When using Zotero 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 Zotero information quick **search) is a program that lets you do this from the command line.

Zoinks is a companion to 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 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 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 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.

The vector artwork of a surprised person, used as the icon for this repository, was created by Adrien Coquet from the Noun Project. It is licensed under the Creative Commons CC-BY 3.0 license.

Owner

  • Name: Michael Hucka
  • Login: mhucka
  • Kind: user
  • Location: Santa Barbara, California, USA
  • Company: Google Quantum AI

Staff Software Engineer @ Google

Citation (CITATION.cff) 

# YAML 1.2
---
authors: 
  -
    affiliation: "Caltech Library"
    given-names: Mike
    family-names: Hucka
    orcid: "0000-0001-9105-5960"
cff-version: "1.1.0"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/mhucka/zoinks"
title: ""
date-released: 2023-12-22
version: "0.0.8"
keywords: 
  - Zotero
  - command-line software
  - bibliographic management
  - macOS
...

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "name": "Zoinks",
  "description": "Zoinks is a command-line utility to retrieve fields from Zotero entries",
  "version": "0.0.8",
  "softwareVersion": "0.0.8",
  "datePublished": "2023-12-22",
  "author": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Hucka",
      "affiliation": "California Institute of Technology Library",
      "email": "mhucka@caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Hucka",
      "affiliation": "California Institute of Technology Library",
      "email": "mhucka@caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Hucka",
      "affiliation": "California Institute of Technology Library",
      "email": "mhucka@caltech.edu",
      "@id": "https://orcid.org/0000-0001-9105-5960"
    }
  ],
  "copyrightYear": 2023,
  "license": "https://github.com/mhucka/zoinks/blob/master/LICENSE",
  "readme": "https://github.com/mhucka/zoinks/blob/main/README.md",
  "releaseNotes": "https://github.com/mhucka/zoinks/blob/main/CHANGES.md",
  "issueTracker": "https://github.com/mhucka/zoinks/issues",
  "downloadUrl": "https://github.com/mhucka/zoinks/archive/main.zip",
  "codeRepository": "https://github.com/mhucka/zoinks",
  "relatedLink": "https://pypi.org/project/zoinks",
  "isAccessibleForFree": true,
  "keywords": [
    "software",
    "metadata",
    "Zotero",
    "bibliography",
    "bibliographic-reference",
    "automation",
    "command line"
  ],
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "Python",
    "version": "3.8",
    "url": "https://www.python.org/"
  },
  "developmentStatus": "active",
  "dateCreated": "2021-10-16"
}

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Issues and Pull Requests

Last synced: 9 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
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 44 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 8
  • Total maintainers: 1
pypi.org: zoinks

Zoinks: a command-line utility to retrieve Zotero record values

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 44 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 17.7%
Dependent repos count: 21.7%
Average: 24.8%
Forks count: 29.8%
Downloads: 44.9%
Maintainers (1)
mhucka
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • aenum ==3.1.0
  • appscript ==1.1.2
  • commonpy ==1.8.1
  • plac ==1.3.3
  • pytest ==6.2.5
  • requests ==2.25.1
  • setuptools ==58.3.0
  • sidetrack ==2.0.0
  • uritools ==3.0.0
requirements-dev.txt pypi
  • pyinstaller >=6.3.0 development
  • pytest >=7.3.0 development
  • pytest-cov >=4.1.0 development
  • pytest-mock >=3.12.0 development
  • twine * development
setup.py pypi