File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ ![ Code Quality] ( https://github.com/shenek/python-streamson/workflows/Code%20Quality/badge.svg )
2+ ![ Security audit] ( https://github.com/shenek/python-streamson/workflows/Security%20audit/badge.svg )
3+
14# Python streamson
25
3- Python bindings for streamson. A memory efficient json splitter.
6+ Python bindings for streamson. A memory efficient json splitter written in Rust.
7+ The project is still in an early phase, but it seems to be working
48
59## Installation
6- TODO
10+ ``` bash
11+ pip install streamson
12+ ```
713
8- ## Examples
14+ ## Usage
915### Simple
1016``` python
1117>> > import streamson
1925(' {"users"}[2]' , ' bob' )
2026```
2127
28+ ## Motivation
29+ This project is meant to be use as a fast json splitter.
30+ Its main purpose is to split raw binary data instead of parsing it.
31+ It is supposed to be fast and memory efficient.
32+
2233## Developer Docs
2334
24- ## Build
25- TODO poetry for dev-dependencies pip for install
35+ ### Build
36+ Poetry is used to manage python dev-dependencies. After you [ install] ( https://python-poetry.org/docs/#installation ) it you can run:
37+ ``` bash
38+ poetry install
39+ ```
40+
2641### Precommit deployment
42+ To pass the basic lints you may want to install pre-push hook to
43+ pre-commit to be sure that CI won't fail in the first step.
2744``` bash
2845poetry run pre-commit install -t pre-push
2946```
You can’t perform that action at this time.
0 commit comments