Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-json-stream/badge/?version=latest
:target: https://docs.circuitpython.org/projects/json_stream/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
This library is a reimplementation and subset of `json_stream <https://github.com/daggaz/json-stream>`_. It enables reading JSON data from a stream rather that loading it all into memory at once. The interface works like lists and dictionaries that are usually returned from ``json.load()`` but require in-order access. Out of order accesses will lead to missing keys and list entries.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
This library is on PyPI for editors that use it for CircuitPython. In CPython,
it is recommended to use `json_stream <https://github.com/daggaz/json-stream>`_ itself.
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_json_stream
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import ssl
import time
import adafruit_requests
import socketpool
import wifi
import adafruit_json_stream as json_stream
pool = socketpool.SocketPool(wifi.radio)
session = adafruit_requests.Session(pool, ssl.create_default_context())
SCORE_URL = "http://site.api.espn.com/apis/site/v2/sports/baseball/mlb/scoreboard"
while True:
resp = session.get(SCORE_URL)
json_data = json_stream.load(resp.iter_content(32))
for event in json_data["events"]:
if "Seattle" not in event["name"]:
continue
for competition in event["competitions"]:
for competitor in competition["competitors"]:
print(competitor["team"]["displayName"], competitor["score"])
resp.close()
time.sleep(60)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/json_stream/en/latest/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-json-stream",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, json_stream",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/70/15e0fcc7d57d6dfb9446e79b889561e8ef334dd4f07e46341912be121e60/adafruit_circuitpython_json_stream-0.8.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-json-stream/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/json_stream/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\n\nThis library is a reimplementation and subset of `json_stream <https://github.com/daggaz/json-stream>`_. It enables reading JSON data from a stream rather that loading it all into memory at once. The interface works like lists and dictionaries that are usually returned from ``json.load()`` but require in-order access. Out of order accesses will lead to missing keys and list entries.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nThis library is on PyPI for editors that use it for CircuitPython. In CPython,\nit is recommended to use `json_stream <https://github.com/daggaz/json-stream>`_ itself.\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_json_stream\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import ssl\n import time\n import adafruit_requests\n import socketpool\n import wifi\n import adafruit_json_stream as json_stream\n\n pool = socketpool.SocketPool(wifi.radio)\n session = adafruit_requests.Session(pool, ssl.create_default_context())\n\n SCORE_URL = \"http://site.api.espn.com/apis/site/v2/sports/baseball/mlb/scoreboard\"\n\n while True:\n resp = session.get(SCORE_URL)\n json_data = json_stream.load(resp.iter_content(32))\n for event in json_data[\"events\"]:\n if \"Seattle\" not in event[\"name\"]:\n continue\n for competition in event[\"competitions\"]:\n for competitor in competition[\"competitors\"]:\n print(competitor[\"team\"][\"displayName\"], competitor[\"score\"])\n resp.close()\n time.sleep(60)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/json_stream/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "0.8.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" json_stream"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0f9a94f8054d7f868bff37ed72e1f56439545ca37a35c815573988f0f23667f",
"md5": "d511bdd05d33a734983f1b0fdad44b39",
"sha256": "0789bd966674d9b864757317639ec5ab51c6f89da837b56265692ec40edad0af"
},
"downloads": -1,
"filename": "adafruit_circuitpython_json_stream-0.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d511bdd05d33a734983f1b0fdad44b39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5592,
"upload_time": "2024-10-07T22:31:22",
"upload_time_iso_8601": "2024-10-07T22:31:22.812655Z",
"url": "https://files.pythonhosted.org/packages/d0/f9/a94f8054d7f868bff37ed72e1f56439545ca37a35c815573988f0f23667f/adafruit_circuitpython_json_stream-0.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f7015e0fcc7d57d6dfb9446e79b889561e8ef334dd4f07e46341912be121e60",
"md5": "a188a157566bedb8aa964c8223ad2d0b",
"sha256": "7276854f8a889eb9f8aece20a134deac1b6b6ff947afb58b2c4563c7e8e78eed"
},
"downloads": -1,
"filename": "adafruit_circuitpython_json_stream-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "a188a157566bedb8aa964c8223ad2d0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32224,
"upload_time": "2024-10-07T22:31:23",
"upload_time_iso_8601": "2024-10-07T22:31:23.762041Z",
"url": "https://files.pythonhosted.org/packages/6f/70/15e0fcc7d57d6dfb9446e79b889561e8ef334dd4f07e46341912be121e60/adafruit_circuitpython_json_stream-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_JSON_Stream",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-json-stream"
}
JSON
