Skip to main content

A utility for managing Door43 Resource Containers

Project description

Master: [![Build Status](https://travis-ci.org/unfoldingWord-dev/python-resource-container.svg?branch=master)](https://travis-ci.org/unfoldingWord-dev/python-resource-container)

# python-resource-container
A utility for managing Door43 Resource Containers. This follows the specification at http://resource-container.readthedocs.io/en/v0.2/.

## What is an RC?
A Resource Container (RC) is a modular/portable package of translation data.

## Installation
```
pip install resource_container
```

## Requirements

python 2.7+

## Usage
To get started you must first load an RC. Then you can read/write as needed.

```python
from resource_container import factory


rc = factory.load('/path/to/resource/container/dir')

# some attributes have dedicated properties
print(rc.type)

# other attributes are accessible from the manifest
print(rc.manifest['dublin_core']['rights'])

# read
chapter = rc.read_chunk('01', 'title')

# write
rc.write_chunk('front', 'title', 'Some book title')
```

### Multiple Projects
It is possible for an RC to contain multiple projects.
In such cases methods like writing and reading chunks will
throw an error telling you to specify the project.

```python
# assume rc contains the projects: gen, exo.

# this throws an error
rc.read_chunk('01', 'title')

# you can check how many projects are in an rc
rc.project_count

# this works as expected
chapter01title = rc.read_chunk('gen', '01', 'title')
```

### Strict Mode

By default the tool will operate in strict mode when loading an RC.
This will perform some checks to ensure the RC is valid.
If you need to look at an RC regardless of it's validity
you can disable strict mode by passing in `False`.

```python
rc = factory.load('/invalid/rc/dir', False)
# do stuff with the invalid rc
```


### Creating an RC

This tool also allows you to create a brand new RC.

> NOTE: currently you must specify the complete manifest manually.
> This might change a little in the future.

```python
manifest = {
...
}

rc = factory.create('/my/rc/dir/', manifest)
# do stuff with your new rc
```

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

resource_container-1.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

resource_container-1.0-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file resource_container-1.0.tar.gz.

File metadata

File hashes

Hashes for resource_container-1.0.tar.gz
Algorithm Hash digest
SHA256 7edb21248d0a65904ea5b433f2a86cd2e0c27757bf1e98186e720d60c30861a0
MD5 967b1fe4401bd446a708aa3da8f3eeb8
BLAKE2b-256 13c1c716ac343ae02c1ecced1f1b8e7be1e3d9a6ca2d19406247fda8d3d1680a

See more details on using hashes here.

File details

Details for the file resource_container-1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for resource_container-1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 26624b5d099873ba4c971131c4941872bb7b5e65e0bc26abcb3a853744c698e3
MD5 4433dfb292759b365c45e8b180b58711
BLAKE2b-256 e889fb83e5b4be7ef24f07b0772e3b0d8032c11552b55e37e6d28a63117e088c

See more details on using hashes here.

Supported by

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