zoinks


Namezoinks JSON
Version 0.0.8 PyPI version JSON
download
home_pagehttps://github.com/mhucka/zoinks
SummaryZoinks: a command-line utility to retrieve Zotero record values
upload_time2023-12-23 00:52:29
maintainer
docs_urlNone
authorMike Hucka
requires_python>=3.9
licenseBSD 3-clause license
keywords python applications
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Zoinks<img width="10%" align="right" src="https://github.com/mhucka/zoinks/raw/main/.graphics/zoinks-icon.png">
======

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.

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square)](https://choosealicense.com/licenses/bsd-3-clause)
[![Latest release](https://img.shields.io/github/v/release/mhucka/zoinks.svg?style=flat-square&color=b44e88)](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**!" &mdash; _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&ndash;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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mhucka/zoinks",
    "name": "zoinks",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "Python,applications",
    "author": "Mike Hucka",
    "author_email": "mhucka@caltech.edu",
    "download_url": "https://files.pythonhosted.org/packages/57/e3/025c8b36c50b5b5a4fa281170ce89aa2b09f6de7acec5abfd41fe8f878c1/zoinks-0.0.8.tar.gz",
    "platform": null,
    "description": "Zoinks<img width=\"10%\" align=\"right\" src=\"https://github.com/mhucka/zoinks/raw/main/.graphics/zoinks-icon.png\">\n======\n\nZoinks (_**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.\n\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square)](https://choosealicense.com/licenses/bsd-3-clause)\n[![Latest release](https://img.shields.io/github/v/release/mhucka/zoinks.svg?style=flat-square&color=b44e88)](https://github.com/mhucka/zoinks/releases)\n\n\nTable of contents\n-----------------\n\n* [Introduction](#introduction)\n* [Installation](#installation)\n* [Usage](#usage)\n* [Known issues and limitations](#known-issues-and-limitations)\n* [Getting help](#getting-help)\n* [Contributing](#contributing)\n* [License](#license)\n* [Acknowledgments](#authors-and-acknowledgments)\n\n\nIntroduction\n------------\n\n> \"Shaggy has a characteristic speech pattern, marked by his frequent use of the filler word \"like\" and, when startled, his exclamations of \"**Zoinks**!\" &mdash; _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._\n\nWhen 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.\n\nZoinks 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.\n\n\nInstallation\n------------\n\n[... forthcoming ...]\n\n\nUsage\n-----\n\n[... forthcoming ...]\n\n\nKnown issues and limitations\n----------------------------\n\n[... forthcoming ...]\n\n\nGetting help\n------------\n\nIf you find an issue, please submit it in [the GitHub issue tracker](https://github.com/mhucka/zoinks/issues) for this repository.\n\n\nContributing\n------------\n\nI 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.\n\n\nLicense\n-------\n\nThis software is Copyright (C) 2022&ndash;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.\n\n\nAcknowledgments\n---------------\n\nThis 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).\n\nThe [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.\n",
    "bugtrack_url": null,
    "license": "BSD 3-clause license",
    "summary": "Zoinks: a command-line utility to retrieve Zotero record values",
    "version": "0.0.8",
    "project_urls": {
        "Bug Tracker": "https://github.com/mhucka/zoinks/issues",
        "Homepage": "https://github.com/mhucka/zoinks",
        "Source Code": "https://github.com/mhucka/zoinks"
    },
    "split_keywords": [
        "python",
        "applications"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1e625f5c8785af911340c2519b34486e4ec52b82f5b957559c629dda22d6d1af",
                "md5": "5f0a4e3824753726ede6c396a8880f22",
                "sha256": "f28b6bfde314104665528d29e9a788d622eb91c063c37a6d1ab0fb420391784f"
            },
            "downloads": -1,
            "filename": "zoinks-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5f0a4e3824753726ede6c396a8880f22",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11984,
            "upload_time": "2023-12-23T00:52:27",
            "upload_time_iso_8601": "2023-12-23T00:52:27.762590Z",
            "url": "https://files.pythonhosted.org/packages/1e/62/5f5c8785af911340c2519b34486e4ec52b82f5b957559c629dda22d6d1af/zoinks-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "57e3025c8b36c50b5b5a4fa281170ce89aa2b09f6de7acec5abfd41fe8f878c1",
                "md5": "9490f7247ecad57ae23b5ece8c2783a6",
                "sha256": "3973e7aa3cfe8c6b87d3efab75c6530ef0523f93f38747fef886172a126e907a"
            },
            "downloads": -1,
            "filename": "zoinks-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "9490f7247ecad57ae23b5ece8c2783a6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 12287,
            "upload_time": "2023-12-23T00:52:29",
            "upload_time_iso_8601": "2023-12-23T00:52:29.352215Z",
            "url": "https://files.pythonhosted.org/packages/57/e3/025c8b36c50b5b5a4fa281170ce89aa2b09f6de7acec5abfd41fe8f878c1/zoinks-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-23 00:52:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mhucka",
    "github_project": "zoinks",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "zoinks"
}
        
Elapsed time: 0.20539s