documentation added

README.rst

@@ -14,7 +14,7 @@ paxb
 
 
 Python Architecture for XML Binding
-===================================
+-----------------------------------
 
 paxb is a library that provides an API for mapping between XML documents and Python objects.
 
@@ -33,7 +33,7 @@ API can be mixed together.
 
 
 Installation
-============
+------------
 
 You can install paxb with pip:
 
@@ -43,15 +43,21 @@ You can install paxb with pip:
 
 
 Requirements
-============
+------------
 
 - `attrs <https://www.attrs.org/en/stable/index.html>`_
 
 
+Documentation
+-------------
+
+Documentation is available at `readthedocs <https://paxb.readthedocs.io/en/latest/>`_.
+
+
 Quick start
-===========
+-----------
 
-user.xml:
+Suppose you have an xml document ``user.xml``:
 
 .. code-block:: xml
 
@@ -87,10 +93,13 @@ user.xml:
     </doc:envelope>
 
 
-main.py:
+To deserialize the document you can use ``xml.etree.ElementTree`` api to parse the document and then set the
+corresponding class fields. Such an imperative code has a lot of boilerplate operations. Instead you can
+write declarative style code describing field mappings and types:
 
 .. code-block:: python
 
+    import json
     import re
     from datetime import date
     from pprint import pprint
@@ -143,44 +152,52 @@ main.py:
             if not re.match(r'\+\d{11,13}', value):
                 raise ValueError("phone number is incorrect")
 
+
     with open('user.xml') as file:
         xml = file.read()
 
+
+Then the deserialized object can be modified and serialized back to xml document or converted to json format:
+
+.. code-block:: python
+
     try:
         user = pb.from_xml(User, xml, envelope='doc:envelope', ns_map={'doc': 'http://www.test1.org'})
         user.birthdate = user.birthdate.replace(year=1993)
-        pprint(attr.asdict(user))
+
+        with open('user.json') as file:
+            json.dump(attr.asdict(user), file)
 
     except (pb.exc.DeserializationError, ValueError) as e:
         print(f"deserialization error: {e}")
 
 
-output:
+``user.json``:
 
-.. code-block:: python
+.. code-block:: json
 
     {
-        'age': 26,
-        'birth_day': 14,
-        'birth_month': 6,
-        'birth_year': 1993,
-        'citizenship': 'RU',
-        'emails': ['alex@gmail.com', 'alex@mail.ru'],
-        'name': 'Alexey',
-        'occupations': [
+        "age": 26,
+        "birth_day": 14,
+        "birth_month": 6,
+        "birth_year": 1993,
+        "citizenship": "RU",
+        "emails": ["alex@gmail.com", "alex@mail.ru"],
+        "name": "Alexey",
+        "occupations": [
             {
-                'address': 'Moscow',
-                'employees': 8854,
-                'title': 'yandex'
+                "address": "Moscow",
+                "employees": 8854,
+                "title": "yandex"
             },
             {
-                'address': 'Yekaterinburg',
-                'employees': 7742,
-                'title': 'skbkontur'
+                "address": "Yekaterinburg",
+                "employees": 7742,
+                "title": "skbkontur"
             }
         ],
-        'passport_number': '836815',
-        'passport_series': '3127',
-        'phone': '+79204563539',
-        'surname': 'Ivanov'
+        "passport_number": "836815",
+        "passport_series": "3127",
+        "phone": "+79204563539",
+        "surname": "Ivanov"
     }

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,59 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'paxb'
+copyright = '2019, Dmitry Pershin'
+author = 'Dmitry Pershin'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# The master toctree document.
+master_doc = 'paxb/index'

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/paxb/api.rst

@@ -0,0 +1,4 @@
+.. _api:
+
+Developer Interface
+===================

docs/paxb/attrs.rst

@@ -0,0 +1,128 @@
+.. _attrs:
+
+attrs library integration
+=========================
+
+As soon as paxb is based on `attrs <https://www.attrs.org/en/stable/index.html>`_ library paxb and attrs
+APIs can be mixed together.
+
+
+Decorator :py:func:`@model` accepts `attr.s <https://www.attrs.org/en/stable/api.html#attr.s>`_ function
+arguments as ``**kwargs`` and internally passes them to it. For example you can pass ``str=True`` argument
+to ask ``attrs`` library to generate ``__str__`` method for a class.
+
+
+Functions :py:func:`attribute`, :py:func:`field` and :py:func:`nested` accept
+`attr.ib <https://www.attrs.org/en/stable/api.html#attr.ib>`_ function arguments as ``**kwargs`` and internally
+passes them to it. For example you can pass ``default`` or ``factory`` argument to set a default value for a class
+field or ``converter`` argument to convert a value to an appropriate type. Look at the example:
+
+.. code-block:: python
+
+    >>> import paxb as pb
+    >>> @pb.model
+    ... class Model:
+    ...     field = pb.field(default='1', converter=int)
+    ...
+    >>> Model()
+    Model(field=1)
+
+
+paxb in conjuction with attrs library can be used as a flexible xml-to-json converter and vise versa. All you
+need is just to declare a model, fields and field types, the rest is up to paxb.
+
+Suppose you have an xml document ``user.xml``:
+
+.. code-block:: xml
+
+    <?xml version="1.0" encoding="utf-8"?>
+    <doc:envelope xmlns:doc="http://www.test1.org">
+        <doc:user name="Alex" surname="Ivanov" age="26">
+
+            <doc:contacts>
+                <doc:phone>+79204563539</doc:phone>
+                <doc:email>alex@gmail.com</doc:email>
+                <doc:email>alex@mail.ru</doc:email>
+            </doc:contacts>
+
+            <data:occupations xmlns:data="http://www.test2.org">
+                <data:occupation title="yandex">
+                    <data:address>Moscow</data:address>
+                    <data:employees>8854</data:employees>
+                </data:occupation>
+                <data:occupation title="skbkontur">
+                    <data:address>Yekaterinburg</data:address>
+                    <data:employees>7742</data:employees>
+                </data:occupation>
+            </data:occupations>
+
+        </doc:user>
+    </doc:envelope>
+
+
+- First you need to describe models:
+
+.. code-block:: python
+
+    import paxb as pb
+
+    @pb.model(name="occupation")
+    class Occupation:
+        title = pb.attr()
+        address = pb.field()
+        employees = pb.field(converter=int)
+
+    @pb.model(name="user", ns="doc")
+    class User:
+        name = pb.attr()
+        surname = pb.attr()
+        age = pb.attr(converter=int)
+
+        phone = pb.wrap("contacts", pb.field())
+        emails = pb.wrap("contacts", pb.as_list(pb.field(name="email")))
+
+        occupations = pb.wrap("occupations", pb.lst(pb.nested(Occupation)), ns="data")
+
+
+- Then deserialize the document to an object:
+
+.. code-block:: python
+
+    with open("user.xml") as file:
+        xml = file.read()
+
+    user = pb.from_xml(User, xml, envelope="doc:envelope", ns_map={
+        "doc": "http://www.test1.org",
+        "data": "http://www.test2.org",
+    })
+
+- Call `asdict <https://www.attrs.org/en/stable/api.html#attr.asdict>`_ attrs library API method:
+
+.. code-block:: python
+
+    with open("user.json") as file:
+        json.dump(attr.asdict(user), file)
+
+- Serialized user file ``user.json``:
+
+.. code-block:: json
+
+    {
+        "name": "Alexey",
+        "surname": "Ivanov",
+        "age": 26,
+        "phone": "+79204563539",
+        "emails": ["alex@gmail.com", "alex@mail.ru"],
+        "occupations": [
+            {
+                "title": "yandex",
+                "address": "Moscow",
+                "employees": 8854
+            },
+            {
+                "title": "skbkontur",
+                "address": "Yekaterinburg",
+                "employees": 7742
+            }
+        ]
+    }