pyjstat-smooth 2.5.0__tar.gz

pyjstat_smooth-2.5.0/.coveragerc

@@ -0,0 +1,2 @@
+[report]
+show_missing = True

pyjstat_smooth-2.5.0/.travis.yml

@@ -0,0 +1,5 @@
+language: python
+python:
+  - "3.7"
+install: "pip install -r requirements.txt"
+script: "pytest pyjstat/test"

pyjstat_smooth-2.5.0/CHANGES.txt

@@ -0,0 +1,22 @@
+v2.5.0  09-10-2026 -- First release as pyjstat-smooth (maintained fork). Added compatibility mechanism.
+v2.4.0  07-02-2023 -- Dataset.read() Add parameter 'fill_category' when it uses a DataFrame, which will be checked if its complete and, if is possible, it will fix it to build the output.
+v2.3.0  20-07-2022 -- to_json_stat() accepts note, role and unit.
+v2.2.1  11-08-2021 -- Fixes #30. Solved import behavior.
+v2.2.0  03-22-2020 -- to_json_stat() accepts now source and updated JSON-stat metadata.
+v2.1.0  03-22-2020 -- Dataset.read() accepts now to_json_stat() optional arguments, to pass a different value column name.
+v2.0.0  02-23-2020 -- Use Pandas 1.X, not backwards compatible. Changed to pytest and pipenv. Accepted PR to potentially disable SSL checks when requesting URLs.
+v1.1.0, 03-03-2017 -- Fixes issues #20 and #22.
+v1.0.1, 03-03-2017 -- Trying to fix pypi RST parsing problems.
+v1.0.0, 02-03-2017 -- Major version release with support for JSON-stat 2.0 datasets, collections and dimensions. Performance improvements. Fixed bug with sparse datasets. Simplified API.
+v0.3.5, 10-24-2016 -- Fixed problem with missing values. Refactored code.
+v0.3.4, 10-02-2016 -- Had to use pandas 0.18.1 version. Problems building 0.19.0 in travis ci.
+v0.3.3, 10-02-2016 -- Fixes #12. Added dimension elements sorting by index when reading json-stat.Added new test case.
+v0.3.2, 11-26-2015 -- Fixes #9. Removed useless code about numeric conversion. Fixed bug making zeroes appear as null in to_json_stat(). Added new test cases.
+v0.3.1, 09-04-2015 -- Solved unicode incompatibilities between Python 2 and 3. Removed zero trailing function in dataframe values and changed labels integer values by strings.
+v0.3.0, 08-20-2015 -- Added initial support for JSON-stat 1.03 datasets. Moved sample test data to files. Added more tests with more real datasets, improved examples, made some minor code improvements and fixes (such as to_json dict order, avoid popping the values list in to_dataframe conversion and unicode issues with Python 3).
+v0.2.0, 08-16-2015 -- Changed example to work with requests module instead of urllib2. Also, fixed code and tests to work in Python 3.4 too. Added Travis CI server synced with Github.
+v0.1.9, 08-15-2015 -- Fixed reported minor bugs and pylint issues. Added value column name as optional parameter in json to dataframe methods.
+v0.1.3, 05-22-2014 -- removed bin references from setup.py.
+v0.1.2, 05-22-2014 -- fixed TypeError in to_json_stat().
+v0.1.1, 05-22-2014 -- Moved example.py from bin directory.
+v0.1.0, 05-22-2014 -- Initial release.

pyjstat_smooth-2.5.0/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyjstat_smooth-2.5.0/MANIFEST.in

@@ -0,0 +1,20 @@
+include *.txt
+include .travis.yml
+include .coveragerc
+recursive-include docs *.puml
+recursive-include examples *.py
+recursive-include docs *.bat
+recursive-include docs *.buildinfo
+recursive-include docs *.css
+recursive-include docs *.doctree
+recursive-include docs *.gif
+recursive-include docs *.html
+recursive-include docs *.inv
+recursive-include docs *.js
+recursive-include docs *.pickle
+recursive-include docs *.png
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+recursive-include pyjstat *.json

pyjstat_smooth-2.5.0/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: pyjstat-smooth
+Version: 2.5.0
+Summary: Maintained fork of pyjstat: handle JSON-stat data in python using pandas DataFrames.
+Home-page: https://github.com/xor34/pyjstat
+Author: Miguel Expósito Martín
+Author-email: miguel.exposito@gmail.com
+License: Apache License 2.0
+Keywords: json-stat,json,statistics,dataframe,converter
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: pandas
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+**LAST RELEASE 2.0**: update to 2.0 version is highly recommended, since it 
+supports JSON-stat 2.0 and brings other improvements. Also, Version 2.X starts 
+to **support Pandas 1.X, and won't have backwards compatibility**.
+**WARNING**: support for Python 2.7 has been removed in pyjstat 2.0.
+
+=======
+pyjstat
+=======
+
+.. image:: https://travis-ci.org/predicador37/pyjstat.svg?branch=master
+    :target: https://travis-ci.org/predicador37/pyjstat
+
+**pyjstat** is a python library for **JSON-stat** formatted data manipulation
+which allows reading and writing JSON-stat [1]_ format with python,using the
+DataFrame structures provided by the widely accepted pandas library [2]_.
+The JSON-stat format is a simple lightweight JSON format for data
+dissemination, currently in its 2.0 version.
+Pyjstat is inspired in rjstat [3]_, a library to read and write
+JSON-stat with R, by ajschumacher. Note that, like in the rjstat project,
+not all features are supported (i.e. not all metadata are converted).
+**pyjstat** is provided under the Apache License 2.0.
+
+.. [1] http://json-stat.org/ for JSON-stat information
+.. [2] http://pandas.pydata.org for Python Data Analysis Library information
+.. [3] https://github.com/ajschumacher/rjstat for rjstat library information
+
+This library was first developed to work with Python 2.7. With some fixes
+(thanks to @andrekittredge), now it works with Python 3.4 too.
+
+Support for JSON-stat 1.3 and 2.0 is provided. JSON-stat 1.3 methods are
+deprecated now and shouldn't be used in the future, but backwards compatibility
+has been preserved.
+
+Pyjstat 1.0 is aimed for simplicity. JSON-stat classes have been replicated
+(Dataset, Collection and Dimension) and provided with simple read() and write()
+methods. Funcionality covers common use cases as having a URL or dataframe
+as data sources.
+
+Methods for retrieving the value of a particular cube cell are taken from the
+JSON-stat Javascript sample code. Thanks to @badosa for this.
+
+Also, version 1.0 makes use of the requests package internally, which should
+make downloading of datasets easier.
+
+Test coverage is 88% and Travis CI is used.
+
+Finally, note that the new classes and methods are inspired by JSON-stat 2.0,
+and hence, won't work with previous versions of JSON-stat. However, older
+methods are still available incorporating bug fixes and performance
+improvements.
+
+Installation
+============
+
+pyjstat requires pandas package. For installation::
+
+    pip install pyjstat
+
+Usage of version 1.0 and newer (with JSON-stat 2.0 support)
+===========================================================
+
+Dataset operations: read and write
+----------------------------------
+
+Typical usage often looks like this::
+
+    from pyjstat import pyjstat
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/galicia.json'
+
+    # read from json-stat
+    dataset = pyjstat.Dataset.read(EXAMPLE_URL)
+
+    # write to dataframe
+    df = dataset.write('dataframe')
+    print(df)
+
+    # read from dataframe
+    dataset_from_df = pyjstat.Dataset.read(df)
+
+    # write to json-stat
+    print(dataset_from_df.write())
+
+Dataset operation: get_value
+----------------------------------
+
+This operation mimics the Javascript example in the JSON-stat web page::
+
+    from pyjstat import pyjstat
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/oecd.json'
+    query = [{'concept': 'UNR'}, {'area': 'US'}, {'year': '2010'}]
+
+    dataset = pyjstat.Dataset.read(EXAMPLE_URL)
+    print(dataset.get_value(query))
+
+Collection operations: read and write
+-------------------------------------
+
+A collection can be parsed into a list of dataframes::
+
+    from pyjstat import pyjstat
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/collection.json'
+
+    collection = pyjstat.Collection.read(EXAMPLE_URL)
+    df_list = collection.write('dataframe_list')
+    print(df_list)
+
+Example with UK ONS API
+-----------------------
+
+In the following example, apikey parameter must be replaced by a real api key
+from ONS. This dataset corresponds to residence type by sex by age in London::
+
+    EXAMPLE_URL = 'http://web.ons.gov.uk/ons/api/data/dataset/DC1104EW.json?'\
+                  'context=Census&jsontype=json-stat&apikey=yourapikey&'\
+                  'geog=2011HTWARDH&diff=&totals=false&'\
+                  'dm/2011HTWARDH=E12000007'
+    dataset = pyjstat.Dataset.read(EXAMPLE_URL)
+    df = dataset.write('dataframe')
+    print(df)
+
+More examples
+-------------
+
+More examples can be found in the examples directory, both for versions 1.3
+and 2.0.
+
+
+Usage of version 0.3.5 and older (with support for JSON-stat 1.3)
+=================================================================
+
+This syntax is deprecated and therefore not recommended anymore.
+
+From JSON-stat to pandas DataFrame
+-----------------------------------
+
+Typical usage often looks like this::
+
+    from pyjstat import pyjstat
+    import requests
+    from collections import OrderedDict
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/us-labor.json'
+
+    data = requests.get(EXAMPLE_URL)
+    results = pyjstat.from_json_stat(data.json(object_pairs_hook=OrderedDict))
+    print (results)
+
+From pandas DataFrame to JSON-stat
+----------------------------------
+
+The same data can be converted into JSON-stat, with some unavoidable metadata
+loss::
+
+    from pyjstat import pyjstat
+    import requests
+    from collections import OrderedDict
+    import json
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/us-labor.json'
+
+    data = requests.get(EXAMPLE_URL)
+    results = pyjstat.from_json_stat(data.json(object_pairs_hook=OrderedDict))
+    print (results)
+    print (json.dumps(json.loads(pyjstat.to_json_stat(results))))
+
+Changes
+-------
+
+For a changes, fixes, improvements and new features reference, see CHANGES.txt.

pyjstat_smooth-2.5.0/README.rst

@@ -0,0 +1,172 @@
+**LAST RELEASE 2.0**: update to 2.0 version is highly recommended, since it 
+supports JSON-stat 2.0 and brings other improvements. Also, Version 2.X starts 
+to **support Pandas 1.X, and won't have backwards compatibility**.
+**WARNING**: support for Python 2.7 has been removed in pyjstat 2.0.
+
+=======
+pyjstat
+=======
+
+.. image:: https://travis-ci.org/predicador37/pyjstat.svg?branch=master
+    :target: https://travis-ci.org/predicador37/pyjstat
+
+**pyjstat** is a python library for **JSON-stat** formatted data manipulation
+which allows reading and writing JSON-stat [1]_ format with python,using the
+DataFrame structures provided by the widely accepted pandas library [2]_.
+The JSON-stat format is a simple lightweight JSON format for data
+dissemination, currently in its 2.0 version.
+Pyjstat is inspired in rjstat [3]_, a library to read and write
+JSON-stat with R, by ajschumacher. Note that, like in the rjstat project,
+not all features are supported (i.e. not all metadata are converted).
+**pyjstat** is provided under the Apache License 2.0.
+
+.. [1] http://json-stat.org/ for JSON-stat information
+.. [2] http://pandas.pydata.org for Python Data Analysis Library information
+.. [3] https://github.com/ajschumacher/rjstat for rjstat library information
+
+This library was first developed to work with Python 2.7. With some fixes
+(thanks to @andrekittredge), now it works with Python 3.4 too.
+
+Support for JSON-stat 1.3 and 2.0 is provided. JSON-stat 1.3 methods are
+deprecated now and shouldn't be used in the future, but backwards compatibility
+has been preserved.
+
+Pyjstat 1.0 is aimed for simplicity. JSON-stat classes have been replicated
+(Dataset, Collection and Dimension) and provided with simple read() and write()
+methods. Funcionality covers common use cases as having a URL or dataframe
+as data sources.
+
+Methods for retrieving the value of a particular cube cell are taken from the
+JSON-stat Javascript sample code. Thanks to @badosa for this.
+
+Also, version 1.0 makes use of the requests package internally, which should
+make downloading of datasets easier.
+
+Test coverage is 88% and Travis CI is used.
+
+Finally, note that the new classes and methods are inspired by JSON-stat 2.0,
+and hence, won't work with previous versions of JSON-stat. However, older
+methods are still available incorporating bug fixes and performance
+improvements.
+
+Installation
+============
+
+pyjstat requires pandas package. For installation::
+
+    pip install pyjstat
+
+Usage of version 1.0 and newer (with JSON-stat 2.0 support)
+===========================================================
+
+Dataset operations: read and write
+----------------------------------
+
+Typical usage often looks like this::
+
+    from pyjstat import pyjstat
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/galicia.json'
+
+    # read from json-stat
+    dataset = pyjstat.Dataset.read(EXAMPLE_URL)
+
+    # write to dataframe
+    df = dataset.write('dataframe')
+    print(df)
+
+    # read from dataframe
+    dataset_from_df = pyjstat.Dataset.read(df)
+
+    # write to json-stat
+    print(dataset_from_df.write())
+
+Dataset operation: get_value
+----------------------------------
+
+This operation mimics the Javascript example in the JSON-stat web page::
+
+    from pyjstat import pyjstat
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/oecd.json'
+    query = [{'concept': 'UNR'}, {'area': 'US'}, {'year': '2010'}]
+
+    dataset = pyjstat.Dataset.read(EXAMPLE_URL)
+    print(dataset.get_value(query))
+
+Collection operations: read and write
+-------------------------------------
+
+A collection can be parsed into a list of dataframes::
+
+    from pyjstat import pyjstat
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/collection.json'
+
+    collection = pyjstat.Collection.read(EXAMPLE_URL)
+    df_list = collection.write('dataframe_list')
+    print(df_list)
+
+Example with UK ONS API
+-----------------------
+
+In the following example, apikey parameter must be replaced by a real api key
+from ONS. This dataset corresponds to residence type by sex by age in London::
+
+    EXAMPLE_URL = 'http://web.ons.gov.uk/ons/api/data/dataset/DC1104EW.json?'\
+                  'context=Census&jsontype=json-stat&apikey=yourapikey&'\
+                  'geog=2011HTWARDH&diff=&totals=false&'\
+                  'dm/2011HTWARDH=E12000007'
+    dataset = pyjstat.Dataset.read(EXAMPLE_URL)
+    df = dataset.write('dataframe')
+    print(df)
+
+More examples
+-------------
+
+More examples can be found in the examples directory, both for versions 1.3
+and 2.0.
+
+
+Usage of version 0.3.5 and older (with support for JSON-stat 1.3)
+=================================================================
+
+This syntax is deprecated and therefore not recommended anymore.
+
+From JSON-stat to pandas DataFrame
+-----------------------------------
+
+Typical usage often looks like this::
+
+    from pyjstat import pyjstat
+    import requests
+    from collections import OrderedDict
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/us-labor.json'
+
+    data = requests.get(EXAMPLE_URL)
+    results = pyjstat.from_json_stat(data.json(object_pairs_hook=OrderedDict))
+    print (results)
+
+From pandas DataFrame to JSON-stat
+----------------------------------
+
+The same data can be converted into JSON-stat, with some unavoidable metadata
+loss::
+
+    from pyjstat import pyjstat
+    import requests
+    from collections import OrderedDict
+    import json
+
+    EXAMPLE_URL = 'http://json-stat.org/samples/us-labor.json'
+
+    data = requests.get(EXAMPLE_URL)
+    results = pyjstat.from_json_stat(data.json(object_pairs_hook=OrderedDict))
+    print (results)
+    print (json.dumps(json.loads(pyjstat.to_json_stat(results))))
+
+Changes
+-------
+
+For a changes, fixes, improvements and new features reference, see CHANGES.txt.