Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Convert JSON to human readable HTML

Project description

===============================
jsonhumanize
===============================

.. image:: https://badge.fury.io/py/jsonhumanize.png
:target: http://badge.fury.io/py/jsonhumanize

.. image:: https://travis-ci.org/magarcia/jsonhumanize.png?branch=master
:target: https://travis-ci.org/magarcia/jsonhumanize

.. image:: https://pypip.in/d/jsonhumanize/badge.png
:target: https://crate.io/packages/jsonhumanize?version=latest


Convert JSON to human readable HTML

*This is a python version from* `json.human.js
<http://marianoguerra.github.io/json.human.js/>`_

* Free software: MIT license
* Documentation: http://jsonhumanize.rtfd.org.

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

At the command line::

easyinstalljsonhumanizeOr,ifyouhavevirtualenvwrapperinstalled:: mkvirtualenv jsonhumanize
pipinstalljsonhumanize========Usage========Tousejsonhumanizeinaproject::importjsonhumanizeTousejsonhumanizefromcommandline:: json-humanize input.json -o output/index.html

# For more information about command line
jsonhumanizehelp============Contributing============Contributionsarewelcome,andtheyaregreatlyappreciated!Everylittlebithelps,andcreditwillalwaysbegiven.Youcancontributeinmanyways:TypesofContributionsReportBugs           Reportbugsathttps://github.com/magarcia/jsonhumanize/issues.Ifyouarereportingabug,pleaseinclude:Youroperatingsystemnameandversion.Anydetailsaboutyourlocalsetupthatmightbehelpfulintroubleshooting.Detailedstepstoreproducethebug.FixBugs        LookthroughtheGitHubissuesforbugs.Anythingtaggedwith"bug"isopentowhoeverwantstoimplementit.ImplementFeatures                  LookthroughtheGitHubissuesforfeatures.Anythingtaggedwith"feature"isopentowhoeverwantstoimplementit.WriteDocumentation                   jsonhumanizecouldalwaysusemoredocumentation,whetheraspartoftheofficialjsonhumanizedocs,indocstrings,orevenonthewebinblogposts,articles,andsuch.SubmitFeedback               Thebestwaytosendfeedbackistofileanissueathttps://github.com/magarcia/jsonhumanize/issues.Ifyouareproposingafeature:Explainindetailhowitwouldwork.Keepthescopeasnarrowaspossible,tomakeiteasiertoimplement.Rememberthatthisisavolunteerdrivenproject,andthatcontributionsarewelcome:)GetStarted!Readytocontribute?Hereshowtosetupjsonhumanizeforlocaldevelopment.1.ForkthejsonhumanizerepoonGitHub.2.Cloneyourforklocally:: git clone git@github.com:your_name_here/jsonhumanize.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

mkvirtualenvjsonhumanize cd jsonhumanize/
pythonsetup.pydevelop4.Createabranchforlocaldevelopment:: git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

flake8jsonhumanizetests python setup.py test
toxTogetflake8andtox,justpipinstallthemintoyourvirtualenv.6.CommityourchangesandpushyourbranchtoGitHub:: git add .
gitcommitm"Yourdetaileddescriptionofyourchanges." git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
https://travis-ci.org/magarcia/jsonhumanize/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ python -m unittest tests.test_jsonhumanize



History
-------

0.1.1 (2013-09-15)
++++++++++++++++++

* Change tests to nose.
* Add support for Python 2.6 and Python 3.3

0.1.0 (2013-09-15)
++++++++++++++++++

* First release.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page