sales and backwards incompatible info

Author: maxtepkeev

CHANGELOG.rst

@@ -4,21 +4,30 @@ Changelog
 2.1.0 (2018-05-XX)
 ++++++++++++++++++
 
+This release concentrates mostly on stability and adds small features here and there. Some of them
+are backwards incompatible and are marked as such. They shouldn't affect many users since most of
+them were used internally by Python-Redmine. A support for the Files API has been finally added, but
+please be sure to check it's documentation as the implementation on the Redmine side is horrible and
+there are things to keep in mind while working with Files API. Lastly, only until the end of May 2018
+there is a chance to buy a Pro Edition for only 14.99$ instead of the usual 24.99$, this is your
+chance to get an edition with additional features for a good price and to support the further development
+of Python-Redmine, more info `here <https://python-redmine.com/editions.html#pro-edition>`_.
+
 **New Features**:
 
 - Files API support (`Issue #117 <https://github.com/maxtepkeev/python-redmine/issues/117>`__)
 
 **Improvements**:
 
-- ResourceSet's ``filter()`` method became more advanced. It is now possible to filter on all available
-  resource attributes, to follow resource relationships and apply lookups to the filters (see
-  `docs <https://python-redmine.com/introduction.html#methods>`__ for details)
+- *Backwards Incompatible:* ResourceSet's ``filter()`` method became more advanced. It is now possible
+  to filter on all available resource attributes, to follow resource relationships and apply lookups to
+  the filters (see `docs <https://python-redmine.com/introduction.html#methods>`__ for details)
 - ResourceManager class has been refactored:
 
   * ``manager_class`` attribute on the ``Resource`` class can now be used to assign a separate
     ``ResourceManager`` to a resource, that allows outsourcing a resource specific functionality to a
     separate manager class (see ``WikiPageManager`` as an example)
-  * ``request()`` method has been removed
+  * *Backwards Incompatible:* ``request()`` method has been removed
   * ``_construct_*_url()``, ``_prepare_*_request()``, ``_process_*_response()`` methods have been added
     for create, update and delete methods to allow a fine-grained control over these operations
 
@@ -40,19 +49,20 @@ Changelog
 
 **Changes**:
 
-- Issue ``all`` operation now really returns all issues, i.e. both open and closed, instead of only returning
-  open issues in previous versions due to the respect to Redmine's standard behaviour
-- Instead of only returning a token string, ``upload()`` method was modified to return a dict that contains
-  all the data for an upload returned from Redmine, i.e. id and token for Redmine >= 3.4.0, token only for
-  Redmine < 3.4.0. Also it is now possible to use this token and pass it using a ``token`` key instead of the
-  ``path`` key with path to the file in ``uploads`` parameter when doing an upload, this gives more control
-  over the uploading process if needed
-- Removed ``resource_paths`` argument from Redmine object since ``ResourceManager`` now uses a special resource
-  registry, to which, all resources that inherit from any Python-Redmine resource are being automatically added
-- Removed ``container_many`` in favor of ``container_filter``, ``container_create`` and ``container_update``
-  attributes on ``Resource`` object to allow more fine-grained resource setup
-- ``return_raw`` parameter on ``engine.request()`` and ``engine.process_response()`` methods has been removed
-  in favor of ``return_raw_response`` attribute on engine object
+- *Backwards Incompatible:* Issue ``all`` operation now really returns all issues, i.e. both open and closed,
+  instead of only returning open issues in previous versions due to the respect to Redmine's standard behaviour
+- *Backwards Incompatible:* Instead of only returning a token string, ``upload()`` method was modified to return
+  a dict that contains all the data for an upload returned from Redmine, i.e. id and token for Redmine >= 3.4.0,
+  token only for Redmine < 3.4.0. Also it is now possible to use this token and pass it using a ``token`` key
+  instead of the ``path`` key with path to the file in ``uploads`` parameter when doing an upload, this gives
+  more control over the uploading process if needed
+- *Backwards Incompatible:* Removed ``resource_paths`` argument from Redmine object since ``ResourceManager``
+  now uses a special resource registry, to which, all resources that inherit from any Python-Redmine resource
+  are being automatically added
+- *Backwards Incompatible:* Removed ``container_many`` in favor of ``container_filter``, ``container_create``
+  and ``container_update`` attributes on ``Resource`` object to allow more fine-grained resource setup
+- *Backwards Incompatible:* ``return_raw`` parameter on ``engine.request()`` and ``engine.process_response()``
+  methods has been removed in favor of ``return_raw_response`` attribute on engine object
 - Updated bundled requests library to v2.15.1
 
 **Bugfixes**:
@@ -121,8 +131,9 @@ user.
     ``pre_*()`` and ``post_*()`` methods
   * ``ResourceSet`` object's ``get()`` and ``filter()`` methods now supports non-integer id's, e.g.
     WikiPage's title can now be used with it
-  * ``ValuesResourceSet`` class has been removed
-  * ``ResourceSet.values()`` method now returns an iterable of dicts instead of ``ValuesResourceSet`` object
+  * *Backwards Incompatible:* ``ValuesResourceSet`` class has been removed
+  * *Backwards Incompatible:* ``ResourceSet.values()`` method now returns an iterable of dicts instead of
+    ``ValuesResourceSet`` object
   * ``ResourceSet.values_list()`` method has been added which returns an iterable of tuples with Resource
     values or single values if flattened, i.e. ``flat=True``
 
@@ -146,21 +157,23 @@ user.
 
 **Changes**:
 
-- Renamed package name from ``redmine`` to ``redminelib``
+- *Backwards Incompatible:* Renamed package name from ``redmine`` to ``redminelib``
 - Resource class attributes that were previously tuples are now lists
-- ``_Resource`` class renamed to ``Resource``
-- ``Redmine.custom_resource_paths`` keyword argument renamed to ``resource_paths``
-- ``Redmine.download()`` method now returns a `requests.Response <http://docs.python-requests.org/
-  en/latest/api/#requests.Response>`__ object directly instead of ``iter_content()`` method if a ``savepath``
-  param wasn't provided, this gives user even more control over response data
-- ``Resource.refresh()`` now really refreshes itself instead of returning a new refreshed
-  resource, to get the previous behaviour use ``itself`` param, e.g. ``Resource.refresh(itself=False)``
-- Removed Python 3.2 support
-- Removed ``container_filter``, ``container_create`` and ``container_update`` attributes on ``Resource``
-  object in favor of ``container_many`` attribute
-- Removed ``Resource.translate_params()`` and ``ResourceManager.prepare_params()`` in favor of
-  ``Resource.bulk_decode()``
-- Removed ``is_unicode()``, ``is_string()`` and ``to_string()`` from ``redminelib.utilities``
+- *Backwards Incompatible:* ``_Resource`` class renamed to ``Resource``
+- *Backwards Incompatible:* ``Redmine.custom_resource_paths`` keyword argument renamed to ``resource_paths``
+- *Backwards Incompatible:* ``Redmine.download()`` method now returns a `requests.Response
+  <http://docs.python-requests.org/en/latest/api/#requests.Response>`__ object directly instead of
+  ``iter_content()`` method if a ``savepath`` param wasn't provided, this gives user even more control over
+  response data
+- *Backwards Incompatible:* ``Resource.refresh()`` now really refreshes itself instead of returning a new
+  refreshed resource, to get the previous behaviour use ``itself`` param, e.g. ``Resource.refresh(itself=False)``
+- *Backwards Incompatible:* Removed Python 3.2 support
+- *Backwards Incompatible:* Removed ``container_filter``, ``container_create`` and ``container_update`` attributes
+  on ``Resource`` object in favor of ``container_many`` attribute
+- *Backwards Incompatible:* Removed ``Resource.translate_params()`` and ``ResourceManager.prepare_params()`` in
+  favor of ``Resource.bulk_decode()``
+- *Backwards Incompatible:* Removed ``is_unicode()``, ``is_string()`` and ``to_string()`` from
+  ``redminelib.utilities``
 - Updated bundled requests library to v2.13.0
 
 **Bugfixes**:

README.rst

@@ -2,13 +2,18 @@ Python-Redmine
 ==============
 
 .. image:: https://badge.fury.io/py/python-redmine.svg
-    :target: https://badge.fury.io/py/python-redmine
+   :target: https://badge.fury.io/py/python-redmine
 
 .. image:: https://img.shields.io/travis/maxtepkeev/python-redmine/master.svg
-    :target: https://travis-ci.org/maxtepkeev/python-redmine
+   :target: https://travis-ci.org/maxtepkeev/python-redmine
 
 .. image:: https://img.shields.io/coveralls/maxtepkeev/python-redmine/master.svg
-    :target: https://coveralls.io/r/maxtepkeev/python-redmine?branch=master
+   :target: https://coveralls.io/r/maxtepkeev/python-redmine?branch=master
+
+.. tip::
+
+   Until the end of May 2018 - Pro Edition for 14.99$ instead of 24.99$, more info
+   `here <https://python-redmine.com/editions.html#pro-edition>`_
 
 Python-Redmine is a library for communicating with a `Redmine <http://www.redmine.org>`_
 project management application. Redmine exposes some of it's data via `REST API
@@ -18,36 +23,36 @@ a simple but powerful Pythonic API inspired by a well-known `Django ORM
 
 .. code-block:: python
 
-    >>> from redminelib import Redmine
+   >>> from redminelib import Redmine
 
-    >>> redmine = Redmine('http://demo.redmine.org', username='foo', password='bar')
-    >>> project = redmine.project.get('vacation')
+   >>> redmine = Redmine('http://demo.redmine.org', username='foo', password='bar')
+   >>> project = redmine.project.get('vacation')
 
-    >>> project.id
-    30404
+   >>> project.id
+   30404
 
-    >>> project.identifier
-    'vacation'
+   >>> project.identifier
+   'vacation'
 
-    >>> project.created_on
-    datetime.datetime(2013, 12, 31, 13, 27, 47)
+   >>> project.created_on
+   datetime.datetime(2013, 12, 31, 13, 27, 47)
 
-    >>> project.issues
-    <redminelib.resultsets.ResourceSet object with Issue resources>
+   >>> project.issues
+   <redminelib.resultsets.ResourceSet object with Issue resources>
 
-    >>> project.issues[0]
-    <redminelib.resources.Issue #34441 "Vacation">
+   >>> project.issues[0]
+   <redminelib.resources.Issue #34441 "Vacation">
 
-    >>> dir(project.issues[0])
-    ['assigned_to', 'author', 'created_on', 'description', 'done_ratio',
-    'due_date', 'estimated_hours', 'id', 'priority', 'project', 'relations',
-    'start_date', 'status', 'subject', 'time_entries', 'tracker', 'updated_on']
+   >>> dir(project.issues[0])
+   ['assigned_to', 'author', 'created_on', 'description', 'done_ratio',
+   'due_date', 'estimated_hours', 'id', 'priority', 'project', 'relations',
+   'start_date', 'status', 'subject', 'time_entries', 'tracker', 'updated_on']
 
-    >>> project.issues[0].subject
-    'Vacation'
+   >>> project.issues[0].subject
+   'Vacation'
 
-    >>> project.issues[0].time_entries
-    <redminelib.resultsets.ResourceSet object with TimeEntry resources>
+   >>> project.issues[0].time_entries
+   <redminelib.resultsets.ResourceSet object with TimeEntry resources>
 
 Features
 --------
@@ -71,7 +76,7 @@ The recommended way to install is from Python Package Index (PyPI) with `pip <ht
 
 .. code-block:: bash
 
-    $ pip install python-redmine
+   $ pip install python-redmine
 
 Pro Edition
 +++++++++++

docs/_static/css/python-redmine.css

@@ -62,6 +62,10 @@ ol.multinum>li:before {
     counter-increment: item;
 }
 
+.strike {
+  text-decoration: line-through;
+}
+
 .feature-matrix {
     width: 100%;
     margin-bottom: 24px;

docs/editions.rst

@@ -11,15 +11,18 @@ for details.
 Pro Edition
 -----------
 
+.. role:: strike
+   :class: strike
+
 Supports additional features like async requests to Redmine, additional Redmine plugins and
 so on. Licensed under `Python-Redmine Pro Edition License Version 1.0
 <https://python-redmine.com/license.html#pro-edition>`_. License can be bought `here
 <https://secure.avangate.com/order/checkout.php?PRODS=4708754&QTY=1&CART=1&CARD=1&DISABLE_SHORT_FORM_MOBILE=1>`_
-for 24.99$ (additional taxes and/or charges may apply depending on the country of purchase and
-payment method used), doesn't expire and is valid for the current major Python-Redmine version,
-e.g. if at the time of purchase current Python-Redmine version is 2.0.1 then license will be
-valid for all 2.x.x versions. Below you can find a feature matrix which shows all the differences
-between these editions:
+for :strike:`24.99$` **14.99$ until the end of May 2018** (additional taxes and/or charges may apply (will be
+shown before the purchase) depending on the country of purchase and payment method used), doesn't expire and is
+valid for the current major Python-Redmine version, e.g. if at the time of purchase current Python-Redmine
+version is 2.0.1 then license will be valid for all 2.x.x versions. Below you can find a feature matrix which
+shows all the differences between these editions:
 
 .. Sphinx and our current theme don't provide a way to create a table in the needed
    format, that is why we are using the raw html with redefined theme stylesheet here.

docs/index.rst

@@ -10,10 +10,15 @@ Python-Redmine
 .. image:: https://img.shields.io/coveralls/maxtepkeev/python-redmine/master.svg
    :target: https://coveralls.io/r/maxtepkeev/python-redmine?branch=master
 
+.. tip::
+
+   Until the end of May 2018 - Pro Edition for 14.99$ instead of 24.99$, more info
+   `here <https://python-redmine.com/editions.html#pro-edition>`_
+
 Python-Redmine is a library for communicating with a `Redmine <http://www.redmine.org>`_
 project management application. Redmine exposes some data via `REST API
 <http://www.redmine.org/projects/redmine/wiki/Rest_api>`_ for which Python-Redmine provides
-simple but powerful Pythonic API inspired by a well-known `Django ORM
+a simple but powerful Pythonic API inspired by a well-known `Django ORM
 <https://docs.djangoproject.com/en/dev/topics/db/queries/>`_:
 
 .. code-block:: python