commentjson


Namecommentjson JSON
Version 0.9.0 PyPI version JSON
download
home_pagehttps://github.com/vaidik/commentjson
SummaryAdd Python and JavaScript style comments in your JSON files.
upload_time2020-10-05 18:49:06
maintainer
docs_urlNone
authorVaidik Kapoor
requires_python
license
keywords
VCS
bugtrack_url
requirements lark-parser
Travis-CI
coveralls test coverage No coveralls.
            ===========
commentjson
===========

`commentjson` (Comment JSON) is a Python package that helps you create JSON
files with Python and JavaScript style inline comments. Its API is very similar
to the Python standard library's `json`_ module.

.. _`json`: http://docs.python.org/2/library/json.html

.. image:: https://travis-ci.org/vaidik/commentjson.png

Installation
============

    pip install commentjson

Basic Usage
===========

.. code-block:: python

    >>> import commentjson
    >>>
    >>> json_string = """{
    ...     "name": "Vaidik Kapoor", # Person's name
    ...     "location": "Delhi, India", // Person's location
    ...
    ...     # Section contains info about
    ...     // person's appearance
    ...     "appearance": {
    ...         "hair_color": "black",
    ...         "eyes_color": "black",
    ...         "height": "6"
    ...     }
    ... }"""
    >>>
    >>> json_loaded = commentjson.loads(json_string)
    >>> print json_loaded
    {u'appearance': {u'eyes_color': u'black', u'hair_color': u'black', u'height': u'6'}, u'name': u'Vaidik Kapoor', u'location': u'Delhi, India'}

Documentation
=============

Complete documentation can be found `here`_.

.. _`here`: http://commentjson.readthedocs.org/en/latest/

Tests
=====

    python setup.py test

License
=======

See `license`_.

.. _`license`: https://github.com/vaidik/commentjson/blob/master/LICENSE.rst



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vaidik/commentjson",
    "name": "commentjson",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Vaidik Kapoor",
    "author_email": "kapoor.vaidik@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c0/76/c4aa9e408dbacee3f4de8e6c5417e5f55de7e62fb5a50300e1233a2c9cb5/commentjson-0.9.0.tar.gz",
    "platform": "",
    "description": "===========\ncommentjson\n===========\n\n`commentjson` (Comment JSON) is a Python package that helps you create JSON\nfiles with Python and JavaScript style inline comments. Its API is very similar\nto the Python standard library's `json`_ module.\n\n.. _`json`: http://docs.python.org/2/library/json.html\n\n.. image:: https://travis-ci.org/vaidik/commentjson.png\n\nInstallation\n============\n\n    pip install commentjson\n\nBasic Usage\n===========\n\n.. code-block:: python\n\n    >>> import commentjson\n    >>>\n    >>> json_string = \"\"\"{\n    ...     \"name\": \"Vaidik Kapoor\", # Person's name\n    ...     \"location\": \"Delhi, India\", // Person's location\n    ...\n    ...     # Section contains info about\n    ...     // person's appearance\n    ...     \"appearance\": {\n    ...         \"hair_color\": \"black\",\n    ...         \"eyes_color\": \"black\",\n    ...         \"height\": \"6\"\n    ...     }\n    ... }\"\"\"\n    >>>\n    >>> json_loaded = commentjson.loads(json_string)\n    >>> print json_loaded\n    {u'appearance': {u'eyes_color': u'black', u'hair_color': u'black', u'height': u'6'}, u'name': u'Vaidik Kapoor', u'location': u'Delhi, India'}\n\nDocumentation\n=============\n\nComplete documentation can be found `here`_.\n\n.. _`here`: http://commentjson.readthedocs.org/en/latest/\n\nTests\n=====\n\n    python setup.py test\n\nLicense\n=======\n\nSee `license`_.\n\n.. _`license`: https://github.com/vaidik/commentjson/blob/master/LICENSE.rst\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Add Python and JavaScript style comments in your JSON files.",
    "version": "0.9.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fbf45508da35e42f0055b7c4f02d703c",
                "sha256": "42f9f231d97d93aff3286a4dc0de39bfd91ae823d1d9eba9fa901fe0c7113dd4"
            },
            "downloads": -1,
            "filename": "commentjson-0.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fbf45508da35e42f0055b7c4f02d703c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8653,
            "upload_time": "2020-10-05T18:49:06",
            "upload_time_iso_8601": "2020-10-05T18:49:06.524524Z",
            "url": "https://files.pythonhosted.org/packages/c0/76/c4aa9e408dbacee3f4de8e6c5417e5f55de7e62fb5a50300e1233a2c9cb5/commentjson-0.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-10-05 18:49:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "vaidik",
    "github_project": "commentjson",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "lark-parser",
            "specs": [
                [
                    ">=",
                    "0.7.1"
                ],
                [
                    "<",
                    "0.8.0"
                ]
            ]
        }
    ],
    "lcname": "commentjson"
}
        
Elapsed time: 0.34583s