Skip to main content

Python 3 implementation of Flatdata

Project description

flatdata-py

Build Status

Python 3 implementation of flatdata.

Running the tests

python3 -m nose

Basic usage

Once you have created a flatdata schema file, you can generate a Python module to read your existing flatdata archive:

flatdata-generator --gen py --schema locations.flatdata --output-file locations.py

Using the inspector

flatdata-py comes with a handy tool called the flatdata-inspector to inspect the contents of an archive:

  • from the flatdata-py source directory:
./inspector.py
# or
python3 -m flatdata.lib.inspector
  • if you want to install flatdata-py:
pip3 install flatdata-py[inspector]  # the inspector feature requires IPython
flatdata-inspector -p /path/to/my/flatdata.archive

Using the writer

flatdata-writer is an addition to flatdata-py that can create flatdata archives from a flatdata schema, with the following limitations:

  • does not allow adding additional sub-archives to an existing archive

  • supports only bulk-writing (no streaming)

  • not optimized for performance

  • from the flatdata-py source directory

./writer.py --schema archive.flatdata --output-dir testdir --json-file data.json --resource-name resourcename
#or
python3 -m flatdata.lib.writer --schema archive.flatdata --output-dir testdir --json-file data.json --resource-name resourcename

Note that the flatdata-writer CLI tool can only write one resource at a time. For archives that have multiple non-optional resources, the tool has to be executed separately for each resource. Only after all resources have been written can the archive be opened.

  • if you want to install flatdata-py:
pip3 install flatdata-py[writer]
flatdata-writer --schema archive.flatdata --output-dir testdir --json-file data.json --resource-name resourcename

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

flatdata_py-0.4.7.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

flatdata_py-0.4.7-py2.py3-none-any.whl (18.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flatdata_py-0.4.7.tar.gz.

File metadata

  • Download URL: flatdata_py-0.4.7.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for flatdata_py-0.4.7.tar.gz
Algorithm Hash digest
SHA256 34afff0c10bf4425352da702873094c66adcba9cd2c9a065675f954d959716d9
MD5 f573f0c35f991c1405851749ca7c7e57
BLAKE2b-256 35488cdb9007e16b9a20bab4e725a50ea9965ca0544211288e58164140194deb

See more details on using hashes here.

File details

Details for the file flatdata_py-0.4.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flatdata_py-0.4.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9ca9a8d7c788cc6da8e8278d5b36e1b2220c445a7a1d13c8b6d54bbd21d03333
MD5 ca823e558444e736fd39282653d76836
BLAKE2b-256 54f54007cdabd419cf5922af11a092390afba31a234351915411a5fbfc804b41

See more details on using hashes here.

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