Metadata-Version: 2.1
Name: portabletab
Version: 0.2.0
Summary: Python package for serializing tables in portable format with Capnp.
License: MIT
Author: Takeshi Sagara
Author-email: sagara@info-proto.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: pycapnp (>=1.3.0,<2.0.0)
Description-Content-Type: text/markdown

# PortableTab

A Python package for serializing tables in portable format
using [Cap'n Proto](https://capnproto.org/).

This package is a kind of KVS that outputs data tables
as a set of page files and provides the ability
to quickly retrieve records with a specified number.

## Main Features

- The format of records is defined in Cap'n Proto's schema.
- Once output to page files, tables are essentially read-only.
- When retrieving records, only the necessary portion of
  the page files is opened with mmap, thus saving speed and memory.
- Page files are serialized by Cap'n Proto and are therefore
  architecture independent.

## How to use

Documentation has not yet been created. Please see [sample code](sample.py).

## Development status

Unstable alpha version.

## License

-This package is available according to the MIT license.

