Skip to main content

A utility for managing Door43 Resource Containers

Project description

Master: [![Build Status](](

# python-resource-container
A utility for managing Door43 Resource Containers. This follows the specification at

## 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.

from resource_container import factory

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

# some attributes have dedicated properties

# other attributes are accessible from the manifest

# 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.

# 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

# 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`.

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.

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

Uploaded Source

Built Distribution

resource_container-1.1-py2.py3-none-any.whl (9.8 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