Skip to content

Commit

Permalink
Preparing release
Browse files Browse the repository at this point in the history
  • Loading branch information
tefra committed Dec 10, 2020
1 parent 4299b4f commit 8f0cacd
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 58 deletions.
9 changes: 9 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
20.12 (2020-12-10)
--------------------
- Added SerializerConfig with new options. `#268 <https://github.com/tefra/xsdata/issues/268>`_, `#320 <https://github.com/tefra/xsdata/issues/320>`_
- Added docstring styles: rst, google, numpy, accessible. `#318 <https://github.com/tefra/xsdata/issues/318>`_, `#340 <https://github.com/tefra/xsdata/issues/340>`_
- Added `max line length` generator configuration. `#342 <https://github.com/tefra/xsdata/issues/342>`_
- Added dynamic type locator for parsers. `#332 <https://github.com/tefra/xsdata/issues/332>`_
- Fixed multiple issues with json binding. `98.7% <https://github.com/tefra/xsdata-w3c-tests/actions>`_ successful roundtrips


20.11.1 (2020-11-13)
--------------------
- Catch all type errors on xsi cache build `#316 <https://github.com/tefra/xsdata/issues/316>`_
Expand Down
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ prune docs/_build
prune docs/_static
prune docs/reference
prune docs/demo
exclude .travis.yml
exclude .readthedocs.yml
exclude .pre-commit-config.yaml

Expand Down
24 changes: 6 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,22 +60,10 @@ Features
- Pluggable code writer that supports python dataclasses and PlantUML class diagrams.


Changelog: 20.11.1 (2020-11-13)
-------------------------------
- Catch all type errors on xsi cache build `#316 <https://github.com/tefra/xsdata/issues/316>`_

Changelog: 20.11 (2020-11-10)
Changelog: 20.12 (2020-12-10)
-----------------------------
- Added sub command to download remote schemas and definitions. `#279 <https://github.com/tefra/xsdata/issues/279>`_
- Added new optional xml type `Elements` to maintain ordering for repeatable choices. `#296 <https://github.com/tefra/xsdata/issues/296>`_
- Added xsi:type lookup procedure for xs:anyType derived elements. `#306 <https://github.com/tefra/xsdata/issues/306>`_
- Updated simple type flattening detection. `#286 <https://github.com/tefra/xsdata/issues/286>`_
- Updated generator to allow namespace structure on schemas without target namespace.
- Updated generator to avoid writing min/max occurs metadata for implied values. `#297 <https://github.com/tefra/xsdata/issues/297>`_
- Update generator to use literal dictionary initialization.
- Updated parser security, disable lxml network and entities resolve.
- Fixed field types detection for elements with xs:alternative children. `#284 <https://github.com/tefra/xsdata/issues/284>`_
- Fixed file generation to enforce default charset UTF-8. `#302 <https://github.com/tefra/xsdata/issues/302>`_
- Fixed jinja2 undefined namespace var collision. `#298 <https://github.com/tefra/xsdata/issues/298>`_
- Fixed import class name collision. `#300 <https://github.com/tefra/xsdata/issues/300>`_
- Fixed restriction inheritance on xs:group elements. `#301 <https://github.com/tefra/xsdata/issues/301>`_
- Added SerializerConfig with new options. `#268 <https://github.com/tefra/xsdata/issues/268>`_, `#320 <https://github.com/tefra/xsdata/issues/320>`_
- Added docstring styles: rst, google, numpy, accessible. `#318 <https://github.com/tefra/xsdata/issues/318>`_, `#340 <https://github.com/tefra/xsdata/issues/340>`_
- Added `max line length` generator configuration. `#342 <https://github.com/tefra/xsdata/issues/342>`_
- Added dynamic type locator for parsers. `#332 <https://github.com/tefra/xsdata/issues/332>`_
- Fixed multiple issues with json binding. `98.7% <https://github.com/tefra/xsdata-w3c-tests/actions>`_ successful roundtrips
14 changes: 10 additions & 4 deletions docs/data_types_table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,31 +25,37 @@
- duration
- ENTITIES
- ENTITY
- error
- gDay
- gMonth
* -
- gMonth
- gMonthDay
- gYear
- gYearMonth
- hexBinary
- ID
* -
- ID
- IDREF
- IDREFS
- lang
- language
- Name
* -
- Name
- NCName
- NMTOKEN
- NMTOKENS
- normalizedString
- NOTATION
* -
- NOTATION
- simpleDerivationSet
- string
- time
- token
* -
-
-
-
-
-
* - :class:`object`
- anySimpleType
Expand Down
65 changes: 31 additions & 34 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,42 @@
Getting started
===============

Prerequisites
-------------
Install using pip
-----------------

Make sure you have `python >= 3.6` and `pip` up and running.
The recommended method is to use a virtual environment

.. code-block:: bash
$ pip install xsdata
Install using conda
-------------------

.. command-output:: python --version
.. code-block:: bash
$ conda install -c conda-forge xsdata
.. command-output:: pip --version
Verify installation
-------------------

Verify installation using the cli entry point.

.. command-output:: xsdata --help


Requirements
------------

.. admonition:: xsData relies on these awesome libraries and supports `python >= 3.6`
:class: hint

* `lxml <https://lxml.de/>`_ - XML parsing
* `requests <https://requests.readthedocs.io/>`_ - Webservice Default Transport
* `click <https://click.palletsprojects.com/>`_ - CLI entry point
* `toposort <https://pypi.org/project/toposort/>`_ - Resolve class ordering
* `jinja2 <https://jinja.palletsprojects.com/>`_ - Code generation
* `docformatter <https://pypi.org/project/docformatter/>`_ - Code formatting

.. warning::

Expand All @@ -33,32 +59,3 @@ Make sure you have `python >= 3.6` and `pip` up and running.
{'value': typing.Union[int, str, float]}
>>> issubclass(bool, int)
True
----

Install xsData
--------------

Install xsData package using `pip`.

.. code-block:: bash
pip install xsdata
Verify installation using the cli entry point.

.. command-output:: xsdata --help

----

.. admonition:: xsData relies on these awesome libraries
:class: hint

* `lxml <https://lxml.de/>`_ - XML parsing
* `requests <https://requests.readthedocs.io/>`_ - Webservice Default Transport
* `click <https://click.palletsprojects.com/>`_ - CLI entry point
* `toposort <https://pypi.org/project/toposort/>`_ - Resolve class ordering
* `jinja2 <https://jinja.palletsprojects.com/>`_ - Code generation
* `docformatter <https://pypi.org/project/docformatter/>`_ - Code formatting
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = xsdata
version = 20.11.1
version = 20.12
description = Python XML Binding
long_description = file: README.rst
long_description_content_type = text/x-rst
Expand Down

0 comments on commit 8f0cacd

Please sign in to comment.