Skip to content
Python reference implementation of the GUANO bat acoustics metadata specification
Python Makefile
Branch: master
Clone or download
riggsd Tentatively add support for Timestamp UTC offsets of the form '-0700'…
…, despite the fact that this is disallowed by the 1.0 GUANO spec (See: bug #17)
Latest commit c6c81ce Jun 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
docs Allow setting `GuanoFile.wav_data` to fix but in `d500x2guano.py` whe… Aug 9, 2018
tests Tentatively add support for Timestamp UTC offsets of the form '-0700'… Jun 1, 2019
.gitignore Sphinx RST documentation Apr 28, 2017
.travis.yml Continuous integration build all the way down to Python 3.3 Apr 29, 2017
LICENSE.txt Documentation updates and 0.7 release Apr 30, 2017
MANIFEST.in 0.0.11 release Dec 15, 2017
Makefile Makefile tweak (should we remove Twine entirely?) Apr 30, 2017
README.rst Convert README from Markdown to reStructuredText for PyPI support Apr 29, 2017
guano.py Tentatively add support for Timestamp UTC offsets of the form '-0700'… Jun 1, 2019
requirements_dev.txt
setup.py Convert README from Markdown to reStructuredText for PyPI support Apr 29, 2017

README.rst

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

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)
You can’t perform that action at this time.