guano-py
========
This is the `Python`_ reference implementation for `GUANO`_, the “Grand
Unified Acoustic Notation Ontology”, a metadata format for bat acoustics
recordings. It includes a production-ready Python module with full
support for reading and writing GUANO metadata, as well as several
helpful commandline utilities.
For more information about GUANO metadata itself, including the format
specification, see the GUANO project homepage: http://guano-md.org
Documentation for guano-py can be found at: http://guano-py.readthedocs.io
Requirements
============
- Python 2.7 or Python 3.3+
Installation
============
Download and install magically from the Python Package Index::
$> pip install -U guano
In addition to having the ``guano`` Python module available for use in
your own software, you’ll also have a small collection of `useful
scripts`_ to use.
Alternately, you can check out the project from GitHub and install
locally in developer mode to hack on it yourself::
$> git clone https://github.com/riggsd/guano-py.git
$> cd guano-py
$> python setup.py develop
|Build Status| |Documentation Status|
API Usage
=========
.. code:: python
from guano import GuanoFile
# load a .WAV file with (or without) GUANO metadata
g = GuanoFile('test.wav')
# get and set metadata values like a Python dict
print g['GUANO|Version']
>>> 1.0
print g['Make'], g['Model']
>>> 'Pettersson', 'D500X'
g['Species Manual ID'] = 'Myso'
g['Note'] = 'I love GUANO!'
# namespaced fields can be specified separately or pipe-delimited
print g['PET', 'Gain'], g['PET|Gain']
>>> 80, 80
g['SB|Consensus'] = 'Epfu'
g['SB', 'Consensus'] = 'Epfu'
# print all the metadata values
for key, value in g.items():
print '%s: %s' % (key, value)
# write the updated .WAV file back to disk
g.write()
# have some GUANO metadata from some other source? load it from a string
g = GuanoFile.from_string('GUANO|Version:1.0\nTags:voucher,hand-release')
# write GUANO metadata somewhere else, say an Anabat file or text file
with open('sidecar_file.guano', 'wb') as outfile:
outfile.write( g.serialize() )
# teach the parser to recognize custom metadata fields
GuanoFile.register('Anabat', ['Humidity', 'Temperature'], float)
GuanoFile.register('SB', 'Thumbnail Image', guano.base64decode)
.. _Python: http://python.org
.. _GUANO: http://guano-md.org
.. _useful scripts: bin/
.. |Build Status| image:: https://travis-ci.org/riggsd/guano-py.svg?branch=master
:target: https://travis-ci.org/riggsd/guano-py
.. |Documentation Status| image:: https://readthedocs.org/projects/guano-py/badge/?version=latest
:target: http://guano-py.readthedocs.io/en/latest/?badge=latest
Raw data
{
"_id": null,
"home_page": "https://github.com/riggsd/guano-py",
"name": "guano",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bats acoustics metadata guano",
"author": "David A. Riggs",
"author_email": "driggs@myotisoft.com",
"download_url": "https://files.pythonhosted.org/packages/3c/65/d9e284a906750e856f5f16b008432854b5cbe883346b63d57e3fc86ea082/guano-1.0.15.tar.gz",
"platform": null,
"description": "guano-py\n========\n\nThis is the `Python`_ reference implementation for `GUANO`_, the \u201cGrand\nUnified Acoustic Notation Ontology\u201d, a metadata format for bat acoustics\nrecordings. It includes a production-ready Python module with full\nsupport for reading and writing GUANO metadata, as well as several\nhelpful commandline utilities.\n\nFor more information about GUANO metadata itself, including the format\nspecification, see the GUANO project homepage: http://guano-md.org\n\nDocumentation for guano-py can be found at: http://guano-py.readthedocs.io\n\n\nRequirements\n============\n\n- Python 2.7 or Python 3.3+\n\n\nInstallation\n============\n\nDownload and install magically from the Python Package Index::\n\n $> pip install -U guano\n\nIn addition to having the ``guano`` Python module available for use in\nyour own software, you\u2019ll also have a small collection of `useful\nscripts`_ to use.\n\nAlternately, you can check out the project from GitHub and install\nlocally in developer mode to hack on it yourself::\n\n $> git clone https://github.com/riggsd/guano-py.git\n $> cd guano-py\n $> python setup.py develop\n\n|Build Status| |Documentation Status|\n\n\nAPI Usage\n=========\n\n.. code:: python\n\n from guano import GuanoFile\n\n # load a .WAV file with (or without) GUANO metadata\n g = GuanoFile('test.wav')\n\n # get and set metadata values like a Python dict\n print g['GUANO|Version']\n >>> 1.0\n\n print g['Make'], g['Model']\n >>> 'Pettersson', 'D500X'\n\n g['Species Manual ID'] = 'Myso'\n\n g['Note'] = 'I love GUANO!'\n\n # namespaced fields can be specified separately or pipe-delimited\n print g['PET', 'Gain'], g['PET|Gain']\n >>> 80, 80\n\n g['SB|Consensus'] = 'Epfu'\n g['SB', 'Consensus'] = 'Epfu'\n\n # print all the metadata values\n for key, value in g.items():\n print '%s: %s' % (key, value)\n\n # write the updated .WAV file back to disk\n g.write()\n\n # have some GUANO metadata from some other source? load it from a string\n g = GuanoFile.from_string('GUANO|Version:1.0\\nTags:voucher,hand-release')\n\n # write GUANO metadata somewhere else, say an Anabat file or text file\n with open('sidecar_file.guano', 'wb') as outfile:\n outfile.write( g.serialize() )\n\n # teach the parser to recognize custom metadata fields\n GuanoFile.register('Anabat', ['Humidity', 'Temperature'], float)\n GuanoFile.register('SB', 'Thumbnail Image', guano.base64decode)\n\n\n.. _Python: http://python.org\n.. _GUANO: http://guano-md.org\n.. _useful scripts: bin/\n\n.. |Build Status| image:: https://travis-ci.org/riggsd/guano-py.svg?branch=master\n :target: https://travis-ci.org/riggsd/guano-py\n.. |Documentation Status| image:: https://readthedocs.org/projects/guano-py/badge/?version=latest\n :target: http://guano-py.readthedocs.io/en/latest/?badge=latest\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "GUANO, the \"Grand Unified\" bat acoustics metadata format",
"version": "1.0.15",
"project_urls": {
"Homepage": "https://github.com/riggsd/guano-py"
},
"split_keywords": [
"bats",
"acoustics",
"metadata",
"guano"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3a2a07aeac1b9038d524f89fc2999c282e0a3bf75da67d5c8fc9de74e344438",
"md5": "f54da4cc26715bf06262450c4ae4c5b4",
"sha256": "4ee5f09ea1eadc5ea7b6a43dedd657465f221063cdcd615da3c9ad4ab5d12db4"
},
"downloads": -1,
"filename": "guano-1.0.15-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f54da4cc26715bf06262450c4ae4c5b4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 20548,
"upload_time": "2023-11-10T23:45:11",
"upload_time_iso_8601": "2023-11-10T23:45:11.879847Z",
"url": "https://files.pythonhosted.org/packages/b3/a2/a07aeac1b9038d524f89fc2999c282e0a3bf75da67d5c8fc9de74e344438/guano-1.0.15-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c65d9e284a906750e856f5f16b008432854b5cbe883346b63d57e3fc86ea082",
"md5": "632cc7c0ed3192b24fbe66912d0df94d",
"sha256": "c38faa71d8fe3411320700d6120c784b9eb7dddf4ac620cdf0b7902551bad0ef"
},
"downloads": -1,
"filename": "guano-1.0.15.tar.gz",
"has_sig": false,
"md5_digest": "632cc7c0ed3192b24fbe66912d0df94d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18319,
"upload_time": "2023-11-10T23:45:13",
"upload_time_iso_8601": "2023-11-10T23:45:13.562423Z",
"url": "https://files.pythonhosted.org/packages/3c/65/d9e284a906750e856f5f16b008432854b5cbe883346b63d57e3fc86ea082/guano-1.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-10 23:45:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "riggsd",
"github_project": "guano-py",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "guano"
}
JSON
