Skip to main content

Build a cache of files in the folder tree for efficiency and emergency purposes

Project description

BioP JSON format can be used to share text documents and annotations.

biop exposes an API familiar to users of the standard library marshal and pickle modules.

Development of biop happens on GitHub: https://github.com/yfpeng/pengyifan-biop

Getting started

Installing biop (with conda)

$ git clone https://github.com/yfpeng/pengyifan-biop.git
$ cd pengyifan-biop
$ conda env create -f environment2.7.yml
$ source activate biop
$ python setup.py

Encoding the BioC collection object collection:

import bioj
# Serialize ``PDocument`` to a BioP formatted ``str``.
bioc.dumps(document)

# Serialize ``PDocument`` as a BioP formatted stream to ``fp``.
with open(filename, 'w') as fp
    bioc.dump(document, fp)

Decoding the BioP JSON file:

import biop

# Deserialize ``fp`` to a BioP document object.
with open(filename, 'r') as fp:
    biop.load(fp)

Validation

To validate the dataset format, run

jsonschema -i tests/foo.json biop_schema.json

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Developers

License

see LICENSE.txt.

Acknowledgments

We are grateful to the folowing projects: BioC and Brat.

Project details


Download files

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

Files for biop, version 0.1.dev3
Filename, size File type Python version Upload date Hashes
Filename, size biop-0.1.dev3.tar.gz (7.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page