diff --git a/CHANGELOG.md b/CHANGELOG.md index 79fdd9b..e032a23 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +0.1b7 +----- + +- Transferred repository to NMNH-IDSC +- Added `from_xml_parallel()` method to EMuReader to allow parallel + reading of XML files (experimental) +- Added support for pickle and json to EMuRecord objects +- Added check for missing grid fields to the EMuReader and EMuGrid + objects. These methods are intended to allow users to catch when a + required grid field is missing from an export. +- Changed custom data types to be essentially immutable. Previously + attributes could be directly modified. +- Changed loading of schema and config files such that these files are + explicitly loaded when the module is imported. Previously they were + lazy loaded when an associated attribute was accessed. + 0.1b6 ----- diff --git a/docs/conf.py b/docs/conf.py index 3d49919..2758349 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,7 @@ author = "Adam Mansur" # The full version, including alpha/beta/rc tags -release = "0.1b6" +release = "0.1b7" # -- General configuration --------------------------------------------------- diff --git a/docs/user-guide.md b/docs/user-guide.md index 91a3496..8d87773 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -64,7 +64,7 @@ write_xml(records, "update.xml") ``` You can use the experimental -:py:meth:`~xmu.io.EMuReader.from_xml_parallel` method to read large XML +:py:meth:`xmu.io.EMuReader.from_xml_parallel` method to read large XML files more quickly. For example, to create a dict mapping IRNs to records: diff --git a/setup.py b/setup.py index 9cc789c..c361db1 100644 --- a/setup.py +++ b/setup.py @@ -26,7 +26,7 @@ description="Reads and writes XML for Axiell EMu", long_description=long_description, long_description_content_type="text/markdown", - version="0.1b6", + version="0.1b7", classifiers=[ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", diff --git a/xmu/__init__.py b/xmu/__init__.py index 2976313..3debf8b 100644 --- a/xmu/__init__.py +++ b/xmu/__init__.py @@ -24,6 +24,6 @@ strip_tab, ) -__version__ = "0.1b6" +__version__ = "0.1b7" __author__ = "Adam Mansur" __credits__ = "Smithsonian National Museum of Natural History" diff --git a/xmu/containers.py b/xmu/containers.py index 464ab98..8b6dd69 100644 --- a/xmu/containers.py +++ b/xmu/containers.py @@ -294,7 +294,7 @@ class EMuSchema(dict): #: EMuConfig : module-wide configuration parameters. Set automatically #: when an EMuConfig object is created. - #: + #: #: :meta hide-value: config = None @@ -627,13 +627,13 @@ class to use for lists #: EMuConfig : module-wide configuration parameters. Set automatically #: when an EMuConfig object is created. - #: + #: #: :meta hide-value: config = None #: EMuSchema : info about a specific EMu configuration. Set automatically #: when an EMuSchema object is created. - #: + #: #: :meta hide-value: schema = None @@ -778,13 +778,13 @@ class EMuRow(MutableMapping): #: EMuConfig : module-wide configuration parameters. Set automatically #: when an EMuConfig object is created. - #: + #: #: :meta hide-value: config = None #: EMuSchema : info about a specific EMu configuration. Set automatically #: when an EMuSchema object is created. - #: + #: #: :meta hide-value: schema = None @@ -881,13 +881,13 @@ class EMuGrid(MutableSequence): #: EMuConfig : module-wide configuration parameters. Set automatically #: when an EMuConfig object is created. - #: + #: #: :meta hide-value: config = None #: EMuSchema : info about a specific EMu configuration. Set automatically #: when an EMuSchema object is created. - #: + #: #: :meta hide-value: schema = None @@ -1099,13 +1099,13 @@ class to use for lists #: EMuConfig : module-wide configuration parameters. Set automatically #: when an EMuConfig object is created. - #: + #: #: :meta hide-value: config = None #: EMuSchema : info about a specific EMu configuration. Set automatically #: when an EMuSchema object is created. - #: + #: #: :meta hide-value: schema = None diff --git a/xmu/io.py b/xmu/io.py index 0d73862..85aa57e 100644 --- a/xmu/io.py +++ b/xmu/io.py @@ -46,13 +46,13 @@ class EMuReader: #: EMuConfig : module-wide configuration parameters. Set automatically #: when an EMuConfig object is created. - #: + #: #: :meta hide-value: - config = None + config = None #: EMuSchema : info about a specific EMu configuration. Set automatically #: when an EMuSchema object is created. - #: + #: #: :meta hide-value: schema = None