Welcome to okonomiyaki’s documentation!

Okonomiyaki is a small library to deal with Enthought’s specific packaging, platform and index formats. The goal is to consolidate our multiple implementations of the same formats into one library.

Example:

# parsing epd platform strings
from okonomiyaki.platforms import EPDPlatform

epd_platform = EPDPlatform.from_epd_string("rh5-32")
assert epd.platform_name == "rh5"
assert epd.arch_bits == "32"

# creating legacy s3 index entries
from okonomiyaki.repositories import EnpkgS3IndexEntry

s3_index_entry = EnpkgS3IndexEntry.from_egg("numpy-1.7.1-1.egg")
print(s3_index_entry.size)
print(s3_index_entry.packages) # dependencies

As its version suggests, it is still experimental and its API may change in backward-incompatible ways.

User Guide

This part of the documentation focuses on step-by-step instructions for getting the most out of the library.

• Quickstart
  • Querying a jaguar runtime
  • Querying an Enthought egg metadata
  • Packaging files into an Enthought egg
  • Repackaging an existing setuptools egg

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • Enthought egg features
  • Runtimes
  • Platforms representations
  • Repositories format

File formats

If you are looking for information about a specific file format, like our egg or runtime packaging format, this part of the documentation is for you.

• Runtimes