Libearth

-------------

To be released.

- Python 3.2 is no more supported since even pip 8.0.0 also dropped their
support for Python 3.2.
- Parsing RSS 1.0 feed is available. [:issue:`57`]
- Refactoring :mod:`~libearth.parser` package. [:issue:`54`]

- Every single element parser can be specified using
:class:`~libearth.parser.base.ParserBase` and its decorator.
When calling root element parser, the children elements are also parsed in
hierarchical order.
- Basic parsing information is stored in
:class:`~libearth.parser.base.SessionBase` and passed from parent parser
to chlidren parsers.
- Added :func:`~libearth.parser.base.get_element_id`.
It returns the string consists of an XML namespace and an element tag that
:mod:`xml.etree.ElementTree` can recognize when finding children elements.
- Support atom feed that :class:`~libearth.feed.Text` with `xhtml` type.


- Introduced new :mod:`libearth.defaults` module.
This module provides small utilities and default data to fill initial state
of Earth Reader apps.
- HTML sanitizer now does rebase all links in the given document on the base
uri.
The :meth:`~libearth.feed.Text.get_sanitized_html()` method was added to
:class:`~libearth.feed.Text` type.
The :func:`~libearth.sanitizer.sanitize_html()` function became to
additionally require ``base_uri`` parameter.
- Added :meth:`~libearth.session.Session.get_default_name()` for default
session name.

-------------

Released on November 6, 2014.

- Fixed a bug that :func:`~libearth.schema.complete()` never terminates
for documents :func:`~libearth.schema.read()` from a single chunk.

-------------

Released on November 5, 2014.

- Fixed a bug that :class:`~libearth.subscribe.SubscriptionList`\ s having
:class:`~libearth.subscribe.Outline`\ s without their :attr:`created_at
<libearth.subscribe.Outline.created_at>` attribute failed to be merged
on Python 3. [:issue:`65`]
- Fixed a bug that a :class:`~libearth.schema.DocumentElement` in streamed
read mode is not properly marked as complete even when it's completed by
:func:`~libearth.schema.complete()` function in some cases.

-------------

Released on July 20, 2014.

- Fixed two backward compatibility breakages:

- A bug that subcategory changes hadn't been detected when
:class:`~libearth.subscribe.SubscriptionList`\ s are merged.
- A bug that all children outlines become wiped when a category is deleted.

-------------

Released on July 12, 2014.

- Root :class:`~libearth.session.MergeableDocumentElement`\ s'
:meth:`~libearth.session.MergeableDocumentElement.__merge_entities__()`
methods are not ignored anymore. Respnosibilty to merge two documents is
now moved from :meth:`Session.merge() <libearth.session.Session.merge>`
method to :meth:`MergeableDocumentElement.__merge_entities__()
<libearth.session.MergeableDocumentElement.__merge_entities__>` method.
- :func:`~libearth.crawler.crawl()` now return a set of
:class:`~libearth.crawler.CrawlResult` objects instead of :class:`tuple`\ s.
- ``feeds`` parameter of :func:`~libearth.crawler.crawl()` function was
renamed to ``feed_urls``.
- Added ``feed_uri`` parameter and corresponding :attr:`feed_uri
<libearth.crawler.CrawlError.feed_uri>` attribute to
:class:`~libearth.crawler.CrawlError` exception.
- Timeout option was added to crawler.

- Added optional ``timeout`` parameter to :func:`~libearth.crawler.crawl()`.
- Added optional ``timeout`` parameter to
:func:`~libearth.crawler.get_feed()`.
- Added :const:`~libearth.crawler.DEFAULT_TIMEOUT` constant which is
10 seconds.

- Added :attr:`LinkList.favicon <libearth.feed.LinkList.favicon>` property.
[:issue:`49`]
- :attr:`Link.relation <libearth.feed.Link.relation>` attribute which had
been optional now becomes required
- :meth:`AutoDiscovery.find_feed_url()
<libearth.parser.autodiscovery.AutoDiscovery.find_feed_url>` method (that
returned feed links) was gone. Instead :meth:`AutoDiscovery.find()
<libearth.parser.autodiscovery.AutoDiscovery.find>` method (that returns
a pair of feed links and favicon links) was introduced.
[:issue:`49`]
- :attr:`Subscription.icon_uri <libearth.subscribe.Subscription.icon_uri>`
attribute was introduced. [:issue:`49`]
- Added an optional ``icon_uri`` parameter to :meth:`SubscriptionSet.subscribe()
<libearth.subscribe.SubscriptionSet.subscribe>` method. [:issue:`49`]
- Added :func:`~libearth.parser.util.normalize_xml_encoding()`
function to workaround :mod:`xml.etree.ElementTree` module's
`encoding detection bug`__. [:issue:`41`]
- Added :func:`~libearth.tz.guess_tzinfo_by_locale()` function. [:issue:`41`]
- Added ``microseconds`` option to :class:`~libearth.codecs.Rfc822` codec.
- Fixed incorrect merge of subscription/category deletion.

- Subscriptions are now archived rather than deleted.
- :class:`~libearth.subscribe.Outline` (which is a common superclass of
:class:`~libearth.subscribe.Subscription` and
:class:`~libearth.subscribe.Category`) now has
:attr:`~libearth.subscribe.Outline.deleted_at` attribute and
:attr:`~libearth.subscribe.Outline.deleted` property.

- Fixed several :mod:`~libearth.parser.rss2` parser bugs.

- Now the parser accepts several malformed ``<pubDate>`` and
``<lastBuildDate>`` elements.
- It become to guess the time zone according to its ``<language>`` and
the ccTLD (if applicable) when the date time doesn't give any explicit
time zone (which is also malformed). [:issue:`41`]
- It had ignored ``<category>`` elements other than the last one, now it
become to accept as many as there are.
- It had ignored ``<comments>`` links at all, now these become to be
parsed to :class:`~libearth.feed.Link` objects with
``relation='discussion'``.
- Some RSS 2 feeds put a URI into ``<generator>``, so the parser now
treat it as :attr:`~libearth.feed.Generator.uri` rather than
:attr:`~libearth.feed.Generator.value` for such situation.
- ``<enclosure>`` links had been parsed as :class:`~libearth.feed.Link`
object *without* :attr:`~libearth.feed.Link.relation` attribute,
but it becomes to properly set the attribute to ``'enclosure'``.
- Mixed ``<link>`` elements with Atom namespace also becomes to be
parsed well.

- Fixed several :mod:`~libearth.parser.atom` parser bugs.

- Now it accepts obsolete PURL Atom namespace.
- Since some broken Atom feeds (e.g. Naver Blog) provide date time as
:rfc:`822` format which is incorrect according to :rfc:`4287section-3.3`
(section 3.3), the parser becomes to accept :rfc:`822` format as well.
- Some broken Atom feeds (e.g. Naver Blog) use ``<modified>`` which is
not standard instead of ``<updated>`` which is standard, so the parser
now treats ``<modified>`` equivalent to ``<updated>``.
- ``<content>`` and ``<summary>`` can has :mimetype:`text/plain` and
:mimetype:`text/html` in addition to ``text`` and ``html``.
- ``<author>``/``<contributor>`` becomes ignored if it hasn't any of
``<name>``, ``<uri>``, or ``<email>``.
- Fixed a parser bug that hadn't interpret omission of
:attr:`link[rel] <libearth.feed.Link.relation>` attribute
as ``'alternate'``.

- Fixed the parser to work well even if there's any file separator characters
(FS, ``'\x1c'``).

__ http://bugs.python.org/issue13612

-------------

Released on July 12, 2014.

- Fixed :mod:`~libearth.parser.rss2` parsing error when any empty element
occurs.
- Fixed a bug that :func:`~libearth.schema.validate()` function errored
when any subelement has :class:`~libearth.schema.Text` descriptor.