Skip to main content

A python library to access Grambank data

Project description

pygrambank

Curation tools for Grambank data.

Build Status codecov PyPI

Install

pygrambank can be installed from PyPI via

pip install pygrambank

or from a clone of [glottobank/pygrambank]:

git clone ...
cd pygrambank
pip install -e .

You should install pygrambank in a virtual environment to make sure it does not mess with a system-wide Python installation.

CLI

Installing pygrambank will also install a command line program grambank. Data curation functionality is implemented as subcommands of this program. To get information about available subcommands, run

grambank --help

More info on individual subcommands can be obtained running

grambank help <SUBCOMMAND>

e.g.

$ grambank help check

    grambank --repos PATH/TO/Grambank check
    
    Run data quality checks on a grambank repository.

API

pygrambank also allows programmatic access to Grambank data from Python programs. All functionality is mediated through a pygrambank.Grambank instance:

>>> from pygrambank import Grambank
>>> gb = Grambank('.')
>>> gb.sheets_dir
PosixPath('original_sheets')
>>> for sheet in gb.iter_sheets():
...   print(sheet)
...   break
... 
original_sheets/AH_alag1248.tsv

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygrambank-0.2.0.tar.gz (20.0 kB view hashes)

Uploaded Source

Built Distribution

pygrambank-0.2.0-py2.py3-none-any.whl (23.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page