rhgrant10 / ndjson Goto Github PK

Hello @rhgrant10,

I would like to open a PR on your repo to add two things I find myself recoding often and wanted to know whether you would consider those features useful/relevant for your library: a ndjson writer & reader, having a very similar interface as the standard python ones from the csv module. Indeed, those would be very useful when reading the input line by line and when outputing the result in a stream fashion.

Here is an example of the API:

import ndjson

# Reader
with open('./posts.jsonl') as f:
  reader = ndjson.reader(f)

  for post in reader:
    print(post['id'])

# Writer
with open('./posts.jsonl', 'w') as f:
  writer = ndjson.writer(f)

  for item in data:
    writer.writerow(item)

What do you think?

Could you please provide a licence for this package so I can maybe use it in my work?

At the beginning of the README, state clearly what it is good for.

Now you have this:

"""
ndjson
Support for ndjson. Plain and simple.
"""

But what is ndjson? It's a recursive description.

Description

I saw that PyPi.org has a version 0.3.1 which I can't find on GitHub.

What I Did

Visited https://pypi.org/project/ndjson/#history

MyPy doesn't like this and the types don't seem to be available anywhere..

error: Skipping analyzing "ndjson": module is installed, but missing library stubs or py.typed marker
note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports