Skip to main content

A python library to curate Grambank data

Project description

pygrambank

Curation tools for Grambank data.

Build Status PyPI

Install

pygrambank can be installed from PyPI via

pip install pygrambank

or from a clone of [grambank/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 <SUBCOMMAND> -h

e.g.

$ grambank describe -h
usage: grambank describe [-h] [--columns] SHEET

Describe a (set of) sheets.

This includes checking for correctness - i.e. the functionality of `grambank check`.
While references will be parsed, the corresponding sources will **not** be looked up
in Glottolog (since this is slow). Thus, for a final check of a sheet, you must run
`grambank sourcelookup`.

positional arguments:
  SHEET       Path of a specific TSV file to check or substring of a filename
              (e.g. a glottocode)

optional arguments:
  -h, --help  show this help message and exit
  --columns   List columns of the sheet (default: False)

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-2.0.0.tar.gz (46.9 kB view hashes)

Uploaded source

Built Distribution

pygrambank-2.0.0-py2.py3-none-any.whl (56.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page