Documentation update: link README.rst introduction to Sphinx docs
This commit is contained in:
Davide Brunato
parent
22808a61dc
commit
abeb239dce
16
README.rst
16
README.rst
|
|
@ -2,7 +2,9 @@
|
|||
xmlschema
|
||||
*********
|
||||
|
||||
This is an implementation of `XML Schema <http://www.w3.org/2001/XMLSchema>`_
|
||||
.. xmlschema-introduction-start
|
||||
|
||||
The *xmlschema* library is an implementation of `XML Schema <http://www.w3.org/2001/XMLSchema>`_
|
||||
for Python (supports versions 2.7 and Python 3.3+).
|
||||
|
||||
This library arises from the needs of a solid Python layer for processing XML
|
||||
|
|
@ -16,7 +18,8 @@ the schema-based decoding of XML data has led to build this library. Obviously
|
|||
this library can be useful for other cases related to XML Schema based processing,
|
||||
not only for the original scope.
|
||||
|
||||
For more information read the `xmlschema documentation on readthedocs <http://xmlschema.readthedocs.io/en/latest/>`_.
|
||||
The full `xmlschema documentation is available on "Read the Docs" <http://xmlschema.readthedocs.io/en/latest/>`_.
|
||||
|
||||
|
||||
Features
|
||||
========
|
||||
|
|
@ -29,6 +32,8 @@ The xmlschema library includes the following features:
|
|||
* Decoding of XML data into Python data structures
|
||||
* An XPath based API for finding schema's elements and attributes
|
||||
* Support of XSD validation modes
|
||||
* XML-based attacks prevention using the external package *defusedxml*
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
|
|
@ -41,6 +46,9 @@ The library uses the Python's ElementTree XML library and doesn't require additi
|
|||
packages. The library includes also the schemas of the XML Schema standards for working
|
||||
offline and to speed-up the building of schema instances.
|
||||
|
||||
.. xmlschema-introduction-end
|
||||
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
|
|
@ -116,13 +124,13 @@ values that match to the data types declared by the schema:
|
|||
'year': '1925'}]}
|
||||
|
||||
License
|
||||
-------
|
||||
=======
|
||||
This software is distributed under the terms of the MIT License.
|
||||
See the file 'LICENSE' in the root directory of the present
|
||||
distribution, or http://opensource.org/licenses/MIT.
|
||||
|
||||
Roadmap
|
||||
-------
|
||||
=======
|
||||
|
||||
* Validated XML data encoding
|
||||
* XSD 1.1
|
||||
|
|
|
|||
|
|
@ -2,42 +2,6 @@
|
|||
Introduction
|
||||
************
|
||||
|
||||
The *xmlschema* library is an implementation of `XML Schema <http://www.w3.org/2001/XMLSchema>`_
|
||||
for Python (supports versions 2.7 and Python 3.3+).
|
||||
|
||||
This library arises from the needs of a solid Python layer for processing XML
|
||||
Schema based files for
|
||||
`MaX (Materials design at the Exascale) <http://www.max-centre.eu>`_ European project.
|
||||
A significant problem is the encoding and the decoding of the XML data files
|
||||
produced by different simulation software.
|
||||
Another important requirement is the XML data validation, in order to put the
|
||||
produced data under control. The lack of a suitable alternative for Python in
|
||||
the schema-based decoding of XML data has led to build this library. Obviously
|
||||
this library can be useful for other cases related to XML Schema based processing,
|
||||
not only for the original scope.
|
||||
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
The xmlschema library includes the following features:
|
||||
|
||||
* Full XSD 1.0 support
|
||||
* Building of XML schema objects from XSD files
|
||||
* Validation of XML instances against XSD schemas
|
||||
* Decoding of XML data into Python data structures
|
||||
* An XPath based API for finding schema's elements and attributes
|
||||
* Support of XSD validation modes
|
||||
* XML-based attacks prevention using the external package *defusedxml*
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install the library with *pip* in a Python 2.7 or Python 3.3+ environment::
|
||||
|
||||
pip install xmlschema
|
||||
|
||||
The library uses the Python's ElementTree XML library and doesn't require additional
|
||||
packages. The library includes also the schemas of the XML Schema standards for working
|
||||
offline and to speed-up the building of schema instances.
|
||||
.. include:: ../README.rst
|
||||
:start-after: xmlschema-introduction-start
|
||||
:end-before: xmlschema-introduction-end
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Release notes
|
|||
License
|
||||
-------
|
||||
|
||||
This *xmlschema* library is distributed under the terms of the `MIT License <http://opensource.org/licenses/MIT>`_.
|
||||
The *xmlschema* library is distributed under the terms of the `MIT License <http://opensource.org/licenses/MIT>`_.
|
||||
|
||||
Support
|
||||
-------
|
||||
|
|
@ -15,6 +15,5 @@ for source code and for an issue tracker.
|
|||
Roadmap
|
||||
-------
|
||||
|
||||
* Full XSD 1.0 support (almost done)
|
||||
* Validated XML data encoding
|
||||
* XSD 1.1
|
||||
6
setup.py
6
setup.py
|
|
@ -19,10 +19,8 @@ setup(
|
|||
install_requires=['elementpath>=1.0.6', 'defusedxml>=0.5'],
|
||||
packages=['xmlschema', 'xmlschema.validators', 'xmlschema.tests'],
|
||||
package_data={'xmlschema': [
|
||||
'unicode_categories.json',
|
||||
'validators/schemas/*.xsd', 'validators/schemas/*/*.xsd',
|
||||
'tests/test_all.sh', 'tests/cases/*', 'tests/cases/*/*',
|
||||
'tests/cases/*/*/*', 'tests/resources/*'
|
||||
'unicode_categories.json', 'validators/schemas/*.xsd', 'validators/schemas/*/*.xsd',
|
||||
'tests/cases/*', 'tests/cases/*/*', 'tests/cases/*/*/*', 'tests/resources/*'
|
||||
]},
|
||||
author='Davide Brunato',
|
||||
author_email='brunato@sissa.it',
|
||||
|
|
|
|||
Loading…
Reference in New Issue