Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Converts ReStructuredText into JSON

Project description

Converts ReStructuredText into JSON.

  • Sections are JSON list dictionary elements
  • Section Headers become list titles.
  • Field definitions become key/value representations.
  • Directives are ignored.

Example

Input

Python
------
:age: 22
:typing: dynamic, strong

Java
----
:age: 18
:typing: static, strong

Output

[
    {"title": "Python", "age": 22, "typing": "dynamic, strong"}
    {"title": "Java", "age": 18, "typing": "static, strong"}
]

Usage

$ git clone git@github.com:pydanny/simplicity.git
$ cd simplicity/
$ python simplicity.py sample.rst
[
    {
        "description": "A fun programming language.\n\nUsed to build simplicity!",
        "title": "Python",
        "price": 0.0,
        "typing": "dynamic, strong",
        "age": 22,
        "mascot": "snake"
    },
    {
        "age": 18,
        "typing": "static, strong",
        "mascot": "???",
        "title": "Java"
    },
    {
        "url": "https://github.com",
        "mascot": "Octocat",
        "title": "GitHub"
    }
]

Best Used With

Simplicity is designed to be used with these packages:

  • Complexity: A refreshingly simple static site generator, for those who like to work in HTML.
  • redis-py: Redis Python Client

Know of any other good uses for Simplicity? Let me know and I’ll add it to the list!

Examples

History

0.6.4 (2014-01-29)

  • Handle case where the key is not in the dict (thanks @greatdesignisnotenough)

0.6.3 (2013-11-12)

  • Handles RST directives gracefully (ignores them)

0.6.2 (2013-07-25)

  • Fixes the problem with normal text after field definitions.

0.6.1 (2013-07-23)

  • Better multi-line string support
  • Fixed some Python 3 issues
  • Added tests!

0.6.0 (2013-07-19)

  • Support for multi-line strings

0.5.1 (2013-07-16)

  • Fighting poorly documented setup.py issues. :P

0.5.0 (2013-07-16)

  • API Change for easier-to-navigate result data

0.4.2 (2013-07-15)

  • Fix console script entry point

0.4.1 (2013-07-15)

  • History update

0.4.0 (2013-07-15)

  • added type converter

0.3.0 (2013-07-15)

  • Accepts command-line argument

0.2.0 (2013-07-15)

  • Working prototype

0.1.0 (2013-07-15)

  • Pain point
  • Inspiration

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for simplicity, version 0.6.4
Filename, size File type Python version Upload date Hashes
Filename, size simplicity-0.6.4.tar.gz (5.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page