ndjsonlib
Introduction
The ndjsonlib module provides an interface to read and write Dataset-JSON as NDJSON. It can convert to and from the JSON format of Dataset-JSON. It also supports storing NDJSON metadata and data as separate files and combining them for data exchange. Maintaining the metadata in a separate file makes it simple to update the datasetJsonCreationDatetime and the records attributes without requiring an application to re-write the entire file.
The ndjsonlib module was initiated to support a POC implementation of a draft Dataset-JSON API standard. The ndjsonlib module remains under development and its API will evolve.
Basic Structure and Interfaces
- dataset_name.py: Given the dataset name and the directory, the DatasetName class provides the file names needed for the metadata and data parts of the NDJSON dataset.
- data_file.py: The DataFile class provides methods for reading and writing the NDJSON data file
- metadata_file.py: The MetadataFile class provides methods for reading and writing the NDJSON metadata file
- json_data_file.py: The JsonDataFile class returns JSON by reading the NDJSON files and writes NDJSON given a JSON dataset. Basically, this class uses NDJSON as a data store for JSON inputs and outputs.
- ndjson_data_file.py: The NdjsonDataFile reads and writes NDJSON datasets as one file.
Status
The ndjsonlib module has been updated to support Dataset-JSON v1.1 and is still under development. The ndjsonlib module was originally developed to support the Dataset-JSON API Proof-of-Concept.
TODO
- refine API / class interfaces
- complete documentation
- update tests
Metadata
Release files for ndjsonlib 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ndjsonlib-0.0.4.tar.gz | 9.5 kB | Without provenance | Details for ndjsonlib-0.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ndjsonlib-0.0.4-py3-none-any.whl | Python 3 | none | any | Details for ndjsonlib-0.0.4-py3-none-any.whl |
Total release size: 19.1 kB
Release files / ndjsonlib-0.0.4.tar.gz
| Download URL | ndjsonlib-0.0.4.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
70a18532eea8d3b30c91edc8f2b14edf730c9d86739472735cb67a2653e740a9
|
|
BLAKE2b-256 checksum How to use checksums |
4a4339610f009d4336a8d2731680374b0717b1e01f8d770b02a28ade15be8ddb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Release files / ndjsonlib-0.0.4-py3-none-any.whl
| Download URL | ndjsonlib-0.0.4-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f05d4897baa8bdb3579aad4f6b14aee720c2f8a84af9370f1bf93f486927835
|
|
BLAKE2b-256 checksum How to use checksums |
90429961426e4c9ca3b72634c08cc6d8b7b18faf601743e318d469e76c62a1b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Security for ndjsonlib 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.