Python-Redmine
==============
.. image:: https://badge.fury.io/py/python-redmine.svg
:target: https://badge.fury.io/py/python-redmine
.. image:: https://img.shields.io/github/actions/workflow/status/maxtepkeev/python-redmine/tests.yml
:target: https://github.com/maxtepkeev/python-redmine/actions/workflows/tests.yml
.. image:: https://img.shields.io/coverallsCoverage/github/maxtepkeev/python-redmine?branch=master
:target: https://coveralls.io/github/maxtepkeev/python-redmine?branch=master
Python-Redmine is a library for communicating with a `Redmine <http://www.redmine.org>`__
project management application. Redmine exposes some of its data via `REST API
<http://www.redmine.org/projects/redmine/wiki/Rest_api>`__ for which Python-Redmine provides
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
>>> from redminelib import Redmine
>>> redmine = Redmine('http://demo.redmine.org', username='foo', password='bar')
>>> project = redmine.project.get('vacation')
>>> project.id
30404
>>> project.identifier
'vacation'
>>> project.created_on
datetime.datetime(2013, 12, 31, 13, 27, 47)
>>> project.issues
<redminelib.resultsets.ResourceSet object with Issue resources>
>>> 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']
>>> project.issues[0].subject
'Vacation'
>>> project.issues[0].time_entries
<redminelib.resultsets.ResourceSet object with TimeEntry resources>
Features
--------
* Supports 100% of Redmine API
* Supports external Redmine plugins API
* Supports Python 3.7 - 3.12 and PyPy3
* Supports different request engines
* Extendable via custom resources and custom request engines
* Extensively documented
* Provides ORM-style Pythonic API
* And many more...
Installation
------------
Standard Edition
++++++++++++++++
The recommended way to install is from Python Package Index (PyPI) with `pip <http://www.pip-installer.org>`__:
.. code-block:: bash
$ pip install python-redmine
Pro Edition
+++++++++++
License for a Pro Edition can be bought
`here <https://secure.2checkout.com/order/checkout.php?PRODS=4708754&QTY=1&CART=1&CARD=1&DISABLE_SHORT_FORM_MOBILE=1>`__.
You will receive an email with all the details regarding Pro Edition installation process.
Documentation
-------------
Documentation is available at https://python-redmine.com.
Contacts and Support
--------------------
Support for Standard Edition is provided via `GitHub <https://github.com/maxtepkeev/python-redmine/issues>`__
only, while support for Pro Edition is provided both via `GitHub <https://github.com/maxtepkeev/python-redmine/issues>`__
and support@python-redmine.com. Be sure to write from email that was specified during the purchase procedure.
Copyright and License
---------------------
Python-Redmine Standard Edition is licensed under Apache 2.0 license. Python-Redmine Pro Edition is licensed
under the Python-Redmine Pro Edition 1.0 license. Check the `License <https://python-redmine.com/license.html>`__
for details.
Changelog
---------
2.5.0 (2024-03-31)
++++++++++++++++++
**Deprecations**:
- Requests version required >= 2.31.0
**New Features**:
- *Pro Edition:* RedmineUP `Products plugin <https://www.redmineup.com/pages/plugins/products>`__ support
- Issue copying (see `docs <https://python-redmine.com/resources/issue.html#copying>`__ for details)
(`Issue #203 <https://github.com/maxtepkeev/python-redmine/issues/203>`__)
**Improvements**:
- Migrated CI to GitHub Actions, also we now test not only on Linux, but on macOS and Windows as well
- ``dir(resource)`` and ``list(resource)`` now also show properties of an object
- Support for ``issues_assigned`` and ``issues_authored`` relations in User object
(`Issue #317 <https://github.com/maxtepkeev/python-redmine/issues/317>`__)
- Original filename will be used as a filename for all uploaded files if a path was provided and filename wasn't set
- *Pro Edition:* Added support for RedmineUP Contact avatar add/update operations
(see `docs <https://python-redmine.com/resources/contact.html#create-methods>`__ for details)
- *Pro Edition:* Added support for RedmineUP DealCategory ``create()``, ``update()``, ``delete()`` operations
(see `docs <https://python-redmine.com/resources/deal_category.html#create-methods>`__ for details)
- *Pro Edition:* RedmineUP CrmQuery resource now supports ``invoices`` and ``expenses`` relation attributes
- ``PerformanceWarning`` will be issued when Python-Redmine does some unnecessary redirects before the actual
request is made
**Changes**:
- *Backwards Incompatible:* API key is now being sent in the X-Redmine-API-Key header instead of the key GET
parameter which makes things more secure in case of a failed connection, but it might created issues for servers
that don't do custom request header forwarding by default, so be sure to check your web server before upgrading
(`Issue #328 <https://github.com/maxtepkeev/python-redmine/issues/328>`__ and
`Issue #330 <https://github.com/maxtepkeev/python-redmine/issues/330>`__) (thanks to `Tom Misilo <https://github.com/misilot>`__
and `Ricardo Branco <https://github.com/ricardobranco777>`__)
- *Backwards Incompatible:* User ``all`` operation now really returns all users, i.e. not only active, but locked,
registered and anonymous as well instead of only returning just active users in previous versions due to the
respect to Redmine's standard behaviour (`Issue #327 <https://github.com/maxtepkeev/python-redmine/issues/327>`__)
**Bugfixes**:
- Tests were failing on Windows OS
- Tests were failing on Python 3.12 (`Issue #332 <https://github.com/maxtepkeev/python-redmine/pull/332>`__)
(thanks to `Michał Górny <https://github.com/mgorny>`__)
- Some closed Issues weren't converted to Resource objects using ``redmine.search()``
- *Pro Edition:* RedmineUP Invoice resource ``order`` attribute was returned as a dict instead of being converted to
Resource object
- *Pro Edition:* RedmineUP CrmQuery resource ``deals`` and ``contacts`` relation attributes didn't work
- *Pro Edition:* RedmineUP DealStatus resource ``deals`` relation attribute didn't work
**Documentation**:
- Mentioned support for ``author_id`` in Issue's resource filter operation
2.4.0 (2023-01-18)
++++++++++++++++++
**Deprecations**:
- Requests version required >= 2.28.2
- Removed Python 2.7, 3.5, 3.6 support as it's not supported by Requests anymore
- Removed support for ``python setup.py test`` as it became deprecated by setuptools
**New Features**:
- *Pro Edition:* RedmineUP `Helpdesk plugin <https://www.redmineup.com/pages/plugins/helpdesk>`__ support
(`Issue #116 <https://github.com/maxtepkeev/python-redmine/issues/116>`__)
- *Pro Edition:* RedmineUP `Invoices plugin <https://www.redmineup.com/pages/plugins/invoices>`__ support
(`Issue #301 <https://github.com/maxtepkeev/python-redmine/issues/301>`__)
- Timezone support (see `docs <https://python-redmine.com/configuration.html#timezone>`__ for details)
(`Issue #271 <https://github.com/maxtepkeev/python-redmine/issues/271>`__)
**Improvements**:
- Added support for Python 3.10, 3.11 and latest PyPy
- Added support for `allowed_statuses` to ``include`` param and on demand includes for Issue resource (requires
Redmine >= 5.0.0)
- Added support for `issue_custom_fields` to ``include`` param and on demand includes for Project resource (requires
Redmine >= 4.2.0)
- Added support for `comments` and `attachments` to ``include`` param and on demand includes for News resource
(requires Redmine >= 4.1.0)
- *Pro Edition:* Added support for RedmineUP Contact `projects` to ``include`` param and on demand includes for
``all()`` and ``filter()`` operations
- *Pro Edition:* Added support for RedmineUP Note ``create()``, ``update()``, ``delete()`` operations (see `docs
<https://python-redmine.com/resources/note.html#create-methods>`__ for details)
- Added support for Project ``close()``, ``reopen()``, ``archive()``, ``unarchive()`` operations (see `docs
<https://python-redmine.com/resources/project.html#additional-methods>`__ for details, requires Redmine >= 5.0.0)
- Added support for updating and deleting issue journals (see `docs
<https://python-redmine.com/resources/issue.html#journals>`__ for details, requires Redmine >= 5.0.0)
**Changes**:
- *Backwards Incompatible:* Switched to pytest instead of nose as nose project is dead
(`Issue #312 <https://github.com/maxtepkeev/python-redmine/issues/312>`__)
- *Backwards Incompatible:* Removed usage of distutils.LooseVersion internally since it became deprecated and
caused warnings, because of that all version info internally is now being represented as tuples and not strings
as before
**Bugfixes**:
- Stop raising `ResourceAttrError` for attributes that actually exist, but their value is `None`
(`Issue #261 <https://github.com/maxtepkeev/python-redmine/pull/261>`__)
- *Pro Edition:* RedmineUP Deal resource ``related_contacts`` attribute was returned as a list instead of being converted to
ResourceSet object
- Project resource ``default_assignee`` attribute was returned as a dict instead of being converted to
Resource object
- Project resource ``time_entry_activities`` attribute was returned as a list instead of being converted to
ResourceSet object
**Documentation**:
- Document requirement of `project_id` param for `query_id` filter (`Issue #285 <https://github.com/maxtepkeev/
python-redmine/pull/285>`__) (thanks to `Doezer <https://github.com/Doezer>`__)
- Mentioned support for ``user_id`` in TimeEntry's resource create/update (`Issue #298 <https://github.com/
maxtepkeev/python-redmine/issues/298>`__)
- Mentioned support for additional scopes for Search API
2.3.0 (2020-05-21)
++++++++++++++++++
**Deprecations**:
- Requests version required >= 2.23.0
- Removed Python 3.4 support as it's not supported by Requests anymore
**Improvements**:
- Support custom filename in ``redmine.upload()``
- Support for ``get()`` and ``update()`` operations for ``/my/account`` endpoint which doesn't require admin
privileges by using ``me`` as an id, i.e. ``redmine.user.get('me')`` or ``redmine.user.update('me',firstname='John')``
(requires Redmine >= 4.1.0)
- News ``create()``, ``update()``, ``delete()`` operations support (requires Redmine >= 4.1.0)
- ResourceSet's ``export()`` method now supports ``columns`` keyword argument which can be either an iterable
of column names, an "all" string which tells Python-Redmine to export all available columns, "all_gui" string
for GUI like behaviour or iterable of elements with "all_gui" string and additional columns to export
- Added support for special characters in WikiPage titles (`Issue #222 <https://github.com/maxtepkeev/python-redmine/
issues/222>`__) (thanks to `Radek Czajka <https://github.com/rczajka>`__)
- Added ``return_response`` and ``ignore_response`` parameters to engine which allow to skip response processing
and speed up the create/update/delete operation in case response body isn't needed (see
`docs <https://python-redmine.com/advanced/request_engines.html#session>`__ for details)
**Bugfixes**:
- User's ``send_information`` field wasn't sent correctly to Redmine so account information emails were
never sent (`Issue #227 <https://github.com/maxtepkeev/python-redmine/pull/227>`__) (thanks to
`wodny <https://github.com/wodny>`__)
- Project resource ``default_version`` attribute was returned as a dict instead of being converted to
Resource object
- Resource object was leaking memory during initialization (`Issue #257 <https://github.com/maxtepkeev/python-redmine/
issues/257>`__) (thanks to `yihli <https://github.com/qianyi3210>`__)
**Documentation**:
- Introduced detailed parameter list for ``redmine.session``
- Mentioned support for ``admin`` in User's resource create/update
2.2.1 (2019-02-28)
++++++++++++++++++
**Bugfixes**:
- ProjectMembership resource ``group`` attribute was returned as a dict instead of being converted to
Resource object (`Issue #220 <https://github.com/maxtepkeev/python-redmine/issues/220>`__) (thanks
to `Samuel Harmer <https://github.com/samuelharmer>`__)
2.2.0 (2019-01-13)
++++++++++++++++++
**Deprecations**:
- Removed vendored Requests package and make it an external dependency as Requests did
the same with its own dependencies
- Removed Python 2.6 and 3.3 support as they're not supported by Requests anymore
**Improvements**:
- ``PerformanceWarning`` will be issued when Python-Redmine does some unnecessary work under the hood to fix the
clients code problems
**Bugfixes**:
- ``Redmine.upload()`` fails under certain circumstances when used with a file-like object and it contains unicode
instead of bytes (`Issue #216 <https://github.com/maxtepkeev/python-redmine/issues/216>`__)
- ``Redmine.session()`` doesn't restore previous engine if fails (`Issue #211 <https://github.com/maxtepkeev/
python-redmine/issues/211>`__) (thanks to `Dmitry Logvinenko <https://github.com/dm-logv>`__)
2.1.1 (2018-05-02)
++++++++++++++++++
- Fix PyPI package
2.1.0 (2018-05-02)
++++++++++++++++++
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 its 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**:
- *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)
* *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
- Ability to upload file-like objects (`Issue #186 <https://github.com/maxtepkeev/python-redmine/issues/
186>`__) (thanks to `hjpotter92 <https://github.com/hjpotter92>`__)
- Support for retrieving project's time entry activities (see `docs <https://python-redmine.com/resources/
project.html#get>`__ for details)
- Attachment ``update()`` operation support (requires Redmine >= 3.4.0)
- ``Resource.save()`` now accepts ``**attrs`` that need to be changed/set and returns ``self`` instead of a
boolean ``True``, which makes it chainable, so you can now do something like ``project.save(name='foo',
description='bar').export('txt', '/home/foo')``
- ``get`` operation support for News, Query, Enumeration, IssueStatus, Tracker, CustomField, ContactTag,
DealStatus, DealCategory and CRMQuery resources
- ``include`` param in ``get``, ``all`` and ``filter`` operations now accepts lists and tuples instead of
comma-separated string which is still accepted for backward compatibility reasons, i.e. one can use
``include=['foo', 'bar']`` instead of ``include='foo,bar'``
- It is now possible to use ``None`` and ``0`` in addition to ``''`` in ``assigned_to_id`` attribute in
Issue resource if an assignee needs to be removed from an issue
**Changes**:
- *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**:
- Support 204 status code when deleting a resource (`Issue #189 <https://github.com/maxtepkeev/python-redmine/
pull/189>`__) (thanks to `dotSlashLu <https://github.com/dotSlashLu>`__)
- Raise ``ValidationError`` instead of not helpful ``TypeError`` exception when trying to create a WikiPage
resource that already exists (`Issue #182 <https://github.com/maxtepkeev/python-redmine/issues/182>`__)
- Enumeration, Version, Group and Notes ``custom_fields`` attribute was returned as a list of dicts instead
of being converted to ``ResourceSet`` object
- Downloads were downloaded fully into memory instead of being streamed as needed
- ``ResourceRequirementsError`` exception was broken since v2.0.0
- *Pro Edition:* RedmineUP CRM Contact and Deal resources export functionality didn't work
- *Pro Edition:* RedmineUP CRM Contact and Deal resources sometimes weren't converted to Resource objects using Search API
**Documentation**:
- Mentioned support for ``generate_password`` and ``send_information`` in User's resource create/update
methods, ``status`` in User's resource update method, ``parent_id`` in Issue's filter method and ``include``
in Issue's all method
2.0.2 (2017-04-19)
++++++++++++++++++
**Bugfixes**:
- Filter doesn't work when there are > 100 resources requested (`Issue #175 <https://github.com/maxtepkeev/
python-redmine/pull/175>`__) (thanks to `niwatolli3 <https://github.com/niwatolli3>`__)
2.0.1 (2017-04-10)
++++++++++++++++++
- Fix PyPI package
2.0.0 (2017-04-10)
++++++++++++++++++
This version brings a lot of new features and changes, some of them are backward-incompatible, so please
look carefully at the changelog below to find out what needs to be changed in your code to make it work
with this version. Also Python-Redmine now comes in 2 editions: Standard and Pro, please have a look at
this `document <https://python-redmine.com/editions.html>`__ for more details. Documentation was
also significantly rewritten, so it is recommended to reread it even if you are an experienced Python-Redmine
user.
**New Features**:
- *Pro Edition:* RedmineUP `Checklist plugin <https://www.redmineup.com/pages/plugins/checklists>`__ support
- `Request Engines <https://python-redmine.com/advanced/request_engines.html>`__ support. It is
now possible to create engines to define how requests to Redmine are made, e.g. synchronous (one by one)
or asynchronous using threads or processes etc
- ``redmine.session()`` context manager which allows to temporary redefine engine's behaviour
- Search API support (`Issue #138 <https://github.com/maxtepkeev/python-redmine/issues/138>`__)
- Export functionality (`Issue #58 <https://github.com/maxtepkeev/python-redmine/issues/58>`__)
- REDMINE_USE_EXTERNAL_REQUESTS environmental variable for emergency cases which allows to use external
requests instead of bundled one even if external requests version is lower than the bundled one
- Wrong HTTP protocol usage detector, e.g. one use HTTP when HTTPS should be used
**Improvements**:
- ResourceSet objects were completely rewritten:
* ``ResourceSet`` object that was already sliced now supports reslicing
* ``ResourceSet`` object's ``delete()``, ``update()``, ``filter()`` and ``get()`` methods have been
optimized for speed
* ``ResourceSet`` object's ``delete()`` and ``update()`` methods now call the corresponding Resource's
``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
* *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``
- New ``Resource`` object methods:
* ``delete()`` deletes current resource from Redmine
* ``pre_delete()`` and ``post_delete()`` can be used to execute tasks that should be done before/after
deleting the resource through ``delete()`` method
* ``bulk_decode()``, ``bulk_encode()``, ``decode()`` and ``encode()`` which are used to translate
attributes of the resource to/from Python/Redmine
- Attachment ``delete()`` method support (requires Redmine >= 3.3.0)
- *Pro Edition:* RedmineUP CRM Note resource now provides ``type`` attribute which shows text representation of ``type_id``
- *Pro Edition:* RedmineUP CRM DealStatus resource now provides ``status`` attribute which shows text representation of
``status_type``
- WikiPage resource now provides ``project_id`` attribute
- Unicode handling was significantly rewritten and shouldn't cause any more troubles
- ``UnknownError`` exception now contains ``status_code`` attribute which can be used to handle the
exception instead of parsing code from exception's text
- Sync engine's speed improved to 8-12% depending on the amount of resources fetched
**Changes**:
- *Backwards Incompatible:* Renamed package name from ``redmine`` to ``redminelib``
- Resource class attributes that were previously tuples are now lists
- *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**:
- Infinite loop when uploading zero-length files (`Issue #152 <https://github.com/maxtepkeev/python-redmine/
issues/152>`__)
- Unsupported Redmine resource error while trying to use Python-Redmine without installation (`Issue #156
<https://github.com/maxtepkeev/python-redmine/issues/156>`__)
- It was impossible to set ``data``, ``params`` and ``headers`` via ``requests`` keyword argument on
Redmine object
- Calling ``str()`` or ``repr()`` on a Resource was giving incorrect results if exception raising
was turned off for a resource
**Documentation**:
- Switched to the alabaster theme
- Added new sections:
* `Editions <https://python-redmine.com/editions.html>`__
* `Introduction <https://python-redmine.com/introduction.html>`__
* `Request Engines <https://python-redmine.com/advanced/request_engines.html>`__
- Added info about Issue Journals (`Issue #120 <https://github.com/maxtepkeev/python-redmine/issues/120>`__)
- Added note about open/closed issues (`Issue #136 <https://github.com/maxtepkeev/python-redmine/issues/136>`__)
- Added note about regexp custom field filter (`Issue #164 <https://github.com/maxtepkeev/python-redmine/
issues/164>`__)
- Added some new information here and there
1.5.1 (2016-03-27)
++++++++++++++++++
- Changed: Updated bundled requests package to 2.9.1
- Changed: `Issue #124 <https://github.com/maxtepkeev/python-redmine/issues/124>`__ (``project.url``
now uses ``identifier`` rather than ``id`` to generate url for the project resource)
- Fixed: `Issue #122 <https://github.com/maxtepkeev/python-redmine/issues/122>`__ (``ValidationError`` for
empty custom field values was possible under some circumstances with Redmine < 2.5.0)
- Fixed: `Issue #112 <https://github.com/maxtepkeev/python-redmine/issues/112>`__ (``UnicodeEncodeError``
on Python 2 if ``resource_id`` was of ``unicode`` type) (thanks to `Digenis <https://github.com/Digenis>`__)
1.5.0 (2015-11-26)
++++++++++++++++++
- Added: Documented support for new fields and values in User, Issue and IssueRelation resources
- Added: `Issue #109 <https://github.com/maxtepkeev/python-redmine/issues/109>`__ (Smart imports for
vendored packages (see `docs <https://python-redmine.com/installation.html#dependencies>`__
for details)
- Added: `Issue #115 <https://github.com/maxtepkeev/python-redmine/issues/115>`__ (File upload support
for WikiPage resource)
1.4.0 (2015-10-18)
++++++++++++++++++
- Added: `Requests <http://docs.python-requests.org>`__ is now embedded into Python-Redmine
- Added: Python-Redmine is now embeddable to other libraries
- Fixed: Previous release was broken on PyPI
1.3.0 (2015-10-18)
++++++++++++++++++
- Added: `Issue #108 <https://github.com/maxtepkeev/python-redmine/issues/108>`__ (Tests are now
built-in into source package distributed via PyPI)
1.2.0 (2015-07-09)
++++++++++++++++++
- Added: `wheel <http://wheel.readthedocs.io>`__ support
- Added: `Issue #93 <https://github.com/maxtepkeev/python-redmine/issues/93>`__ (``JSONDecodeError``
exception now contains a ``response`` attribute which can be inspected to identify the cause of the
exception)
- Added: `Issue #98 <https://github.com/maxtepkeev/python-redmine/issues/98>`__ (Support for setting
WikiPage resource parent title and converting parent attribute to Resource object instead of being
a dict)
1.1.2 (2015-05-20)
++++++++++++++++++
- Fixed: `Issue #90 <https://github.com/maxtepkeev/python-redmine/issues/90>`__ (Python-Redmine
fails to install on systems with LC_ALL=C) (thanks to `spikergit1 <https://github.com/spikergit1>`__)
1.1.1 (2015-03-26)
++++++++++++++++++
- Fixed: `Issue #85 <https://github.com/maxtepkeev/python-redmine/issues/85>`__ (Python-Redmine
was trying to convert field to date/datetime even when it shouldn't, i.e. if a field looked like
YYYY-MM-DD but wasn't actually a date/datetime field, e.g. wiki page title or issue subject)
1.1.0 (2015-02-20)
++++++++++++++++++
- Added: PyPy2/3 is now officially supported
- Added: Introduced ``enabled_modules`` on demand include in Project resource
- Fixed: `Issue #78 <https://github.com/maxtepkeev/python-redmine/issues/78>`__ (Redmine <2.5.2
returns only single tracker instead of a list of all available trackers when requested from
a CustomField resource which caused an Exception in Python-Redmine, see `this <http://www.
redmine.org/issues/16739>`__ for details)
- Fixed: `Issue #80 <https://github.com/maxtepkeev/python-redmine/issues/80>`__ (If a project
is read-only or doesn't have CRM plugin enabled, an attempt to add/remove Contact resource
to/from it will lead to improper error message)
- Fixed: `Issue #81 <https://github.com/maxtepkeev/python-redmine/issues/81>`__ (Contact's
resource ``tag_list`` attribute was always splitted into single chars) (thanks to `Alexander
Loechel <https://github.com/loechel>`__)
1.0.3 (2015-02-03)
++++++++++++++++++
- Fixed: `Issue #72 <https://github.com/maxtepkeev/python-redmine/issues/72>`__ (If an exception is
raised during JSON decoding process, it should be catched and reraised as Python-Redmine's own
exception, i.e ``redmine.exceptions.JSONDecodeError``)
- Fixed: `Issue #76 <https://github.com/maxtepkeev/python-redmine/issues/76>`__ (It was impossible
to retrieve more than 100 resources for resources which don't support limit/offset natively by
Redmine, i.e. this functionality is emulated by Python-Redmine, e.g. WikiPage, Groups, Roles etc)
1.0.2 (2014-11-13)
++++++++++++++++++
- Fixed: `Issue #55 <https://github.com/maxtepkeev/python-redmine/issues/55>`__ (TypeError was
raised during processing validation errors from Redmine when one of the errors was returned as
a list)
- Fixed: `Issue #59 <https://github.com/maxtepkeev/python-redmine/issues/59>`__ (Raise ForbiddenError
when a 403 is encountered) (thanks to `Rick Harris <https://github.com/rconradharris>`__)
- Fixed: `Issue #64 <https://github.com/maxtepkeev/python-redmine/issues/64>`__ (Redmine and Resource
classes weren't picklable) (thanks to `Rick Harris <https://github.com/rconradharris>`__)
- Fixed: A ResourceSet object with a limit=100, actually returned 125 Resource objects
1.0.1 (2014-09-23)
++++++++++++++++++
- Fixed: `Issue #50 <https://github.com/maxtepkeev/python-redmine/issues/50>`__ (IssueJournal's
``notes`` attribute was converted to Note resource by mistake, bug was introduced in v1.0.0)
1.0.0 (2014-09-22)
++++++++++++++++++
- Added: Support for the `CRM plugin <https://www.redmineup.com/pages/plugins/crm>`__ resources:
* `Contact <https://python-redmine.com/resources/contact.html>`__
* `ContactTag <https://python-redmine.com/resources/contact_tag.html>`__
* `Note <https://python-redmine.com/resources/note.html>`__
* `Deal <https://python-redmine.com/resources/deal.html>`__
* `DealStatus <https://python-redmine.com/resources/deal_status.html>`__
* `DealCategory <https://python-redmine.com/resources/deal_category.html>`__
* `CrmQuery <https://python-redmine.com/resources/crm_query.html>`__
- Added: Introduced new relations for the following resource objects:
* Project - time_entries, deals, contacts and deal_categories relations
* User - issues, time_entries, deals and contacts relations
* Tracker - issues relation
* IssueStatus - issues relation
- Added: Introduced a ``values()`` method in a ResourceSet which returns ValuesResourceSet - a
ResourceSet subclass that returns dictionaries when used as an iterable, rather than resource-instance
objects (see `docs <https://python-redmine.com/introduction.html#methods>`__ for details)
- Added: Introduced ``update()`` and ``delete()`` methods in a ResourceSet object which allow to
bulk update or bulk delete all resources in a ResourceSet object (see
`docs <https://python-redmine.com/introduction.html#methods>`__ for details)
- Fixed: It was impossible to use ResourceSet's ``get()`` and ``filter()`` methods with WikiPage
resource
- Fixed: Several small fixes and enhancements here and there
0.9.0 (2014-09-11)
++++++++++++++++++
- Added: Introduced support for file downloads (see
`docs <https://python-redmine.com/advanced/working_with_files.html>`__ for details)
- Added: Introduced new ``_Resource.requirements`` class attribute where all Redmine plugins
required by resource should be listed (preparations to support non-native resources)
- Added: New exceptions:
* ResourceRequirementsError
- Fixed: It was impossible to set a custom field of date/datetime type using date/datetime
Python objects
- Fixed: `Issue #46 <https://github.com/maxtepkeev/python-redmine/issues/46>`__
(A UnicodeEncodeError was raised in Python 2.x while trying to access a ``url`` property of
a WikiPage resource if it contained non-ascii characters)
0.8.4 (2014-08-08)
++++++++++++++++++
- Added: Support for anonymous Attachment resource (i.e. attachment with ``id`` attr only)
- Fixed: `Issue #42 <https://github.com/maxtepkeev/python-redmine/issues/42>`__ (It was
impossible to create a Project resource via ``new()`` method)
0.8.3 (2014-08-01)
++++++++++++++++++
- Fixed: `Issue #39 <https://github.com/maxtepkeev/python-redmine/issues/39>`__ (It was
impossible to save custom_fields in User resource via ``new()`` method)
0.8.2 (2014-05-27)
++++++++++++++++++
- Added: ResourceSet's ``get()`` method now supports a ``default`` keyword argument which is
returned when a requested Resource can't be found in a ResourceSet and defaults to ``None``,
previously this was hardcoded to ``None``
- Added: It is now possible to use ``getattr()`` with default value without raising a
``ResourceAttrError`` when calling non-existent resource attribute, see `Issue #30
<https://github.com/maxtepkeev/python-redmine/issues/30>`__ for details (thanks to
`hsum <https://github.com/hsum>`__)
- Fixed: `Issue #31 <https://github.com/maxtepkeev/python-redmine/issues/31>`__ (Unlimited
recursion was possible in some situations when on demand includes were used)
0.8.1 (2014-04-02)
++++++++++++++++++
- Added: New exceptions:
* RequestEntityTooLargeError
* UnknownError
- Fixed: `Issue #27 <https://github.com/maxtepkeev/python-redmine/issues/27>`__ (Project and
Issue resources ``parent`` attribute was returned as a dict instead of being converted to
Resource object)
0.8.0 (2014-03-27)
++++++++++++++++++
- Added: Introduced the detection of conflicting packages, i.e. if a conflicting package is
found (PyRedmineWS at this time is the only one), the installation procedure will be aborted
and a warning message will be shown with the detailed description of the problem
- Added: Introduced new ``_Resource._members`` class attribute where all instance attributes
which are not started with underscore should be listed. This will resolve recursion issues
in custom resources because of how ``__setattr__()`` works in Python
- Changed: ``_Resource.attributes`` renamed to ``_Resource._attributes``
- Fixed: Python-Redmine was unable to upload any binary files
- Fixed: `Issue #20 <https://github.com/maxtepkeev/python-redmine/issues/20>`__ (Lowered
Requests version requirements. Python-Redmine now requires Requests starting from 0.12.1
instead of 2.1.0 in previous versions)
- Fixed: `Issue #23 <https://github.com/maxtepkeev/python-redmine/issues/23>`__ (File uploads
via ``update()`` method didn't work)
0.7.2 (2014-03-17)
++++++++++++++++++
- Fixed: `Issue #19 <https://github.com/maxtepkeev/python-redmine/issues/19>`__ (Resources
obtained via ``filter()`` and ``all()`` methods have incomplete url attribute)
- Fixed: Redmine server url with forward slash could cause errors in rare cases
- Fixed: Python-Redmine was incorrectly raising ``ResourceAttrError`` when trying to call
``repr()`` on a News resource
0.7.1 (2014-03-14)
++++++++++++++++++
- Fixed: `Issue #16 <https://github.com/maxtepkeev/python-redmine/issues/16>`__ (When a resource
was created via a ``new()`` method, the next resource created after that inherited all the
attribute values of the previous resource)
0.7.0 (2014-03-12)
++++++++++++++++++
- Added: WikiPage resource now automatically requests all of its available attributes from
Redmine in case if some of them are not available in an existent resource object
- Added: Support for setting date/datetime resource attributes using date/datetime Python objects
- Added: Support for using date/datetime Python objects in all ResourceManager methods, i.e.
``new()``, ``create()``, ``update()``, ``delete()``, ``get()``, ``all()``, ``filter()``
- Fixed: `Issue #14 <https://github.com/maxtepkeev/python-redmine/issues/14>`__ (Python-Redmine
was incorrectly raising ``ResourceAttrError`` when trying to call ``repr()``, ``str()`` and
``int()`` on resources, created via ``new()`` method)
0.6.2 (2014-03-09)
++++++++++++++++++
- Fixed: Project resource ``status`` attribute was converted to IssueStatus resource by mistake
0.6.1 (2014-02-27)
++++++++++++++++++
- Fixed: `Issue #10 <https://github.com/maxtepkeev/python-redmine/issues/10>`__ (Python
Redmine was incorrectly raising ``ResourceAttrError`` while creating some resources via
``new()`` method)
0.6.0 (2014-02-19)
++++++++++++++++++
- Added: ``Redmine.auth()`` shortcut for the case if we just want to check if user provided
valid auth credentials, can be used for user authentication on external resource based on
Redmine user database (see `docs <https://python-redmine.com/advanced/external_auth.html>`__
for details)
- Fixed: ``JSONDecodeError`` was raised in some Redmine versions during some create/update
operations (thanks to `0x55aa <https://github.com/0x55aa>`__)
- Fixed: User resource ``status`` attribute was converted to IssueStatus resource by mistake
0.5.0 (2014-02-09)
++++++++++++++++++
- Added: An ability to create custom resources which allow to easily redefine the behaviour
of existing resources (see `docs <https://python-redmine.com/advanced/custom_resources.html>`__
for details)
- Added: An ability to add/remove watcher to/from issue (see `docs
<https://python-redmine.com/resources/issue.html#watchers>`__ for details)
- Added: An ability to add/remove users to/from group (see `docs
<https://python-redmine.com/resources/group.html#users>`__ for details)
0.4.0 (2014-02-08)
++++++++++++++++++
- Added: New exceptions:
* ConflictError
* ReadonlyAttrError
* ResultSetTotalCountError
* CustomFieldValueError
- Added: Update functionality via ``update()`` and ``save()`` methods for resources (see
`docs <https://python-redmine.com/introduction.html#update>`__ for details):
* User
* Group
* IssueCategory
* Version
* TimeEntry
* ProjectMembership
* WikiPage
* Project
* Issue
- Added: Limit/offset support via ``all()`` and ``filter()`` methods for resources that
doesn't support that feature via Redmine:
* IssueRelation
* Version
* WikiPage
* IssueStatus
* Tracker
* Enumeration
* IssueCategory
* Role
* Group
* CustomField
- Added: On demand includes, e.g. in addition to ``redmine.group.get(1, include='users')``
users for a group can also be retrieved on demand via ``group.users`` if include wasn't set
(see `docs <https://python-redmine.com/resources/index.html>`__ for details)
- Added: ``total_count`` attribute to ResourceSet object which holds the total number
of resources for the current resource type available in Redmine (thanks to
`Andrei Avram <https://github.com/andreiavram>`__)
- Added: An ability to return ``None`` instead of raising a ``ResourceAttrError`` for all
or selected resource objects via ``raise_attr_exception`` kwarg on Redmine object (see
`docs <https://python-redmine.com/configuration.html#exception-control>`__ for
details or `Issue #6 <https://github.com/maxtepkeev/python-redmine/issues/6>`__)
- Added: ``pre_create()``, ``post_create()``, ``pre_update()``, ``post_update()`` resource
object methods which can be used to execute tasks that should be done before/after
creating/updating the resource through ``save()`` method
- Added: Allow to create resources in alternative way via ``new()`` method (see `docs
<https://python-redmine.com/introduction.html#new>`__ for details)
- Added: Allow daterange TimeEntry resource filtering via ``from_date`` and ``to_date``
keyword arguments (thanks to `Antoni Aloy <https://github.com/aaloy>`__)
- Added: An ability to retrieve Issue version via ``version`` attribute in addition to
``fixed_version`` to be more obvious
- Changed: Documentation for resources rewritten from scratch to be more understandable
- Fixed: Saving custom fields to Redmine didn't work in some situations
- Fixed: Issue's ``fixed_version`` attribute was retrieved as dict instead of Version resource
object
- Fixed: Resource relations were requested from Redmine every time instead of caching the
result after first request
- Fixed: `Issue #2 <https://github.com/maxtepkeev/python-redmine/issues/2>`__ (limit/offset
as keyword arguments were broken)
- Fixed: `Issue #5 <https://github.com/maxtepkeev/python-redmine/issues/5>`__ (Version
resource ``status`` attribute was converted to IssueStatus resource by mistake) (thanks
to `Andrei Avram <https://github.com/andreiavram>`__)
- Fixed: A lot of small fixes, enhancements and refactoring here and there
0.3.1 (2014-01-23)
++++++++++++++++++
- Added: An ability to pass Requests parameters as a dictionary via ``requests`` keyword
argument on Redmine initialization, i.e. Redmine('\http://redmine.url', requests={}).
- Fixed: `Issue #1 <https://github.com/maxtepkeev/python-redmine/issues/1>`__ (unable
to connect to Redmine server with invalid ssl certificate).
0.3.0 (2014-01-18)
++++++++++++++++++
- Added: Delete functionality via ``delete()`` method for resources (see `docs
<https://python-redmine.com/introduction.html#delete>`__ for details):
* User
* Group
* IssueCategory
* Version
* TimeEntry
* IssueRelation
* ProjectMembership
* WikiPage
* Project
* Issue
- Changed: ResourceManager ``get()`` method now raises a ``ValidationError`` exception if
required keyword arguments aren't passed
0.2.0 (2014-01-16)
++++++++++++++++++
- Added: New exceptions:
* ServerError
* NoFileError
* ValidationError
* VersionMismatchError
* ResourceNoFieldsProvidedError
* ResourceNotFoundError
- Added: Create functionality via ``create()`` method for resources (see `docs
<https://python-redmine.com/introduction.html#id1>`__ for details):
* User
* Group
* IssueCategory
* Version
* TimeEntry
* IssueRelation
* ProjectMembership
* WikiPage
* Project
* Issue
- Added: File upload support, see ``upload()`` method in Redmine class
- Added: Integer representation to all resources, i.e. ``__int__()``
- Added: Informal string representation to all resources, i.e. ``__str__()``
- Changed: Renamed ``version`` attribute to ``redmine_version`` in all resources to avoid
name intersections
- Changed: ResourceManager ``get()`` method now raises a ``ResourceNotFoundError`` exception
if resource wasn't found instead of returning None in previous versions
- Changed: reimplemented fix for ``__repr__()`` from 0.1.1
- Fixed: Conversion of issue priorities to enumeration resource object didn't work
0.1.1 (2014-01-10)
++++++++++++++++++
- Added: Python 2.6 support
- Changed: WikiPage resource ``refresh()`` method now automatically determines its project_id
- Fixed: Resource representation, i.e. ``__repr__()``, was broken in Python 2.7
- Fixed: ``dir()`` call on a resource object didn't work in Python 3.2
0.1.0 (2014-01-09)
++++++++++++++++++
- Initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/maxtepkeev/python-redmine",
"name": "python-redmine",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": null,
"keywords": "redmine redmineup redminecrm redminelib easyredmine",
"author": "Maxim Tepkeev",
"author_email": "support@python-redmine.com",
"download_url": "https://files.pythonhosted.org/packages/18/b3/c4d0500d81452d0e2296d53ccbc1c18cbea7a1e7dfc8b64935513b915a8f/python-redmine-2.5.0.tar.gz",
"platform": null,
"description": "Python-Redmine\n==============\n\n.. image:: https://badge.fury.io/py/python-redmine.svg\n :target: https://badge.fury.io/py/python-redmine\n\n.. image:: https://img.shields.io/github/actions/workflow/status/maxtepkeev/python-redmine/tests.yml\n :target: https://github.com/maxtepkeev/python-redmine/actions/workflows/tests.yml\n\n.. image:: https://img.shields.io/coverallsCoverage/github/maxtepkeev/python-redmine?branch=master\n :target: https://coveralls.io/github/maxtepkeev/python-redmine?branch=master\n\nPython-Redmine is a library for communicating with a `Redmine <http://www.redmine.org>`__\nproject management application. Redmine exposes some of its data via `REST API\n<http://www.redmine.org/projects/redmine/wiki/Rest_api>`__ for which Python-Redmine provides\na simple but powerful Pythonic API inspired by a well-known `Django ORM\n<https://docs.djangoproject.com/en/dev/topics/db/queries/>`__:\n\n.. code-block:: python\n\n >>> from redminelib import Redmine\n\n >>> redmine = Redmine('http://demo.redmine.org', username='foo', password='bar')\n >>> project = redmine.project.get('vacation')\n\n >>> project.id\n 30404\n\n >>> project.identifier\n 'vacation'\n\n >>> project.created_on\n datetime.datetime(2013, 12, 31, 13, 27, 47)\n\n >>> project.issues\n <redminelib.resultsets.ResourceSet object with Issue resources>\n\n >>> project.issues[0]\n <redminelib.resources.Issue #34441 \"Vacation\">\n\n >>> dir(project.issues[0])\n ['assigned_to', 'author', 'created_on', 'description', 'done_ratio',\n 'due_date', 'estimated_hours', 'id', 'priority', 'project', 'relations',\n 'start_date', 'status', 'subject', 'time_entries', 'tracker', 'updated_on']\n\n >>> project.issues[0].subject\n 'Vacation'\n\n >>> project.issues[0].time_entries\n <redminelib.resultsets.ResourceSet object with TimeEntry resources>\n\nFeatures\n--------\n\n* Supports 100% of Redmine API\n* Supports external Redmine plugins API\n* Supports Python 3.7 - 3.12 and PyPy3\n* Supports different request engines\n* Extendable via custom resources and custom request engines\n* Extensively documented\n* Provides ORM-style Pythonic API\n* And many more...\n\nInstallation\n------------\n\nStandard Edition\n++++++++++++++++\n\nThe recommended way to install is from Python Package Index (PyPI) with `pip <http://www.pip-installer.org>`__:\n\n.. code-block:: bash\n\n $ pip install python-redmine\n\nPro Edition\n+++++++++++\n\nLicense for a Pro Edition can be bought\n`here <https://secure.2checkout.com/order/checkout.php?PRODS=4708754&QTY=1&CART=1&CARD=1&DISABLE_SHORT_FORM_MOBILE=1>`__.\nYou will receive an email with all the details regarding Pro Edition installation process.\n\nDocumentation\n-------------\n\nDocumentation is available at https://python-redmine.com.\n\nContacts and Support\n--------------------\n\nSupport for Standard Edition is provided via `GitHub <https://github.com/maxtepkeev/python-redmine/issues>`__\nonly, while support for Pro Edition is provided both via `GitHub <https://github.com/maxtepkeev/python-redmine/issues>`__\nand support@python-redmine.com. Be sure to write from email that was specified during the purchase procedure.\n\nCopyright and License\n---------------------\n\nPython-Redmine Standard Edition is licensed under Apache 2.0 license. Python-Redmine Pro Edition is licensed\nunder the Python-Redmine Pro Edition 1.0 license. Check the `License <https://python-redmine.com/license.html>`__\nfor details.\n\n\nChangelog\n---------\n\n2.5.0 (2024-03-31)\n++++++++++++++++++\n\n**Deprecations**:\n\n- Requests version required >= 2.31.0\n\n**New Features**:\n\n- *Pro Edition:* RedmineUP `Products plugin <https://www.redmineup.com/pages/plugins/products>`__ support\n- Issue copying (see `docs <https://python-redmine.com/resources/issue.html#copying>`__ for details)\n (`Issue #203 <https://github.com/maxtepkeev/python-redmine/issues/203>`__)\n\n**Improvements**:\n\n- Migrated CI to GitHub Actions, also we now test not only on Linux, but on macOS and Windows as well\n- ``dir(resource)`` and ``list(resource)`` now also show properties of an object\n- Support for ``issues_assigned`` and ``issues_authored`` relations in User object\n (`Issue #317 <https://github.com/maxtepkeev/python-redmine/issues/317>`__)\n- Original filename will be used as a filename for all uploaded files if a path was provided and filename wasn't set\n- *Pro Edition:* Added support for RedmineUP Contact avatar add/update operations\n (see `docs <https://python-redmine.com/resources/contact.html#create-methods>`__ for details)\n- *Pro Edition:* Added support for RedmineUP DealCategory ``create()``, ``update()``, ``delete()`` operations\n (see `docs <https://python-redmine.com/resources/deal_category.html#create-methods>`__ for details)\n- *Pro Edition:* RedmineUP CrmQuery resource now supports ``invoices`` and ``expenses`` relation attributes\n- ``PerformanceWarning`` will be issued when Python-Redmine does some unnecessary redirects before the actual\n request is made\n\n**Changes**:\n\n- *Backwards Incompatible:* API key is now being sent in the X-Redmine-API-Key header instead of the key GET\n parameter which makes things more secure in case of a failed connection, but it might created issues for servers\n that don't do custom request header forwarding by default, so be sure to check your web server before upgrading\n (`Issue #328 <https://github.com/maxtepkeev/python-redmine/issues/328>`__ and\n `Issue #330 <https://github.com/maxtepkeev/python-redmine/issues/330>`__) (thanks to `Tom Misilo <https://github.com/misilot>`__\n and `Ricardo Branco <https://github.com/ricardobranco777>`__)\n- *Backwards Incompatible:* User ``all`` operation now really returns all users, i.e. not only active, but locked,\n registered and anonymous as well instead of only returning just active users in previous versions due to the\n respect to Redmine's standard behaviour (`Issue #327 <https://github.com/maxtepkeev/python-redmine/issues/327>`__)\n\n**Bugfixes**:\n\n- Tests were failing on Windows OS\n- Tests were failing on Python 3.12 (`Issue #332 <https://github.com/maxtepkeev/python-redmine/pull/332>`__)\n (thanks to `Micha\u0142 G\u00f3rny <https://github.com/mgorny>`__)\n- Some closed Issues weren't converted to Resource objects using ``redmine.search()``\n- *Pro Edition:* RedmineUP Invoice resource ``order`` attribute was returned as a dict instead of being converted to\n Resource object\n- *Pro Edition:* RedmineUP CrmQuery resource ``deals`` and ``contacts`` relation attributes didn't work\n- *Pro Edition:* RedmineUP DealStatus resource ``deals`` relation attribute didn't work\n\n**Documentation**:\n\n- Mentioned support for ``author_id`` in Issue's resource filter operation\n\n2.4.0 (2023-01-18)\n++++++++++++++++++\n\n**Deprecations**:\n\n- Requests version required >= 2.28.2\n- Removed Python 2.7, 3.5, 3.6 support as it's not supported by Requests anymore\n- Removed support for ``python setup.py test`` as it became deprecated by setuptools\n\n**New Features**:\n\n- *Pro Edition:* RedmineUP `Helpdesk plugin <https://www.redmineup.com/pages/plugins/helpdesk>`__ support\n (`Issue #116 <https://github.com/maxtepkeev/python-redmine/issues/116>`__)\n- *Pro Edition:* RedmineUP `Invoices plugin <https://www.redmineup.com/pages/plugins/invoices>`__ support\n (`Issue #301 <https://github.com/maxtepkeev/python-redmine/issues/301>`__)\n- Timezone support (see `docs <https://python-redmine.com/configuration.html#timezone>`__ for details)\n (`Issue #271 <https://github.com/maxtepkeev/python-redmine/issues/271>`__)\n\n**Improvements**:\n\n- Added support for Python 3.10, 3.11 and latest PyPy\n- Added support for `allowed_statuses` to ``include`` param and on demand includes for Issue resource (requires\n Redmine >= 5.0.0)\n- Added support for `issue_custom_fields` to ``include`` param and on demand includes for Project resource (requires\n Redmine >= 4.2.0)\n- Added support for `comments` and `attachments` to ``include`` param and on demand includes for News resource\n (requires Redmine >= 4.1.0)\n- *Pro Edition:* Added support for RedmineUP Contact `projects` to ``include`` param and on demand includes for\n ``all()`` and ``filter()`` operations\n- *Pro Edition:* Added support for RedmineUP Note ``create()``, ``update()``, ``delete()`` operations (see `docs\n <https://python-redmine.com/resources/note.html#create-methods>`__ for details)\n- Added support for Project ``close()``, ``reopen()``, ``archive()``, ``unarchive()`` operations (see `docs\n <https://python-redmine.com/resources/project.html#additional-methods>`__ for details, requires Redmine >= 5.0.0)\n- Added support for updating and deleting issue journals (see `docs\n <https://python-redmine.com/resources/issue.html#journals>`__ for details, requires Redmine >= 5.0.0)\n\n**Changes**:\n\n- *Backwards Incompatible:* Switched to pytest instead of nose as nose project is dead\n (`Issue #312 <https://github.com/maxtepkeev/python-redmine/issues/312>`__)\n- *Backwards Incompatible:* Removed usage of distutils.LooseVersion internally since it became deprecated and\n caused warnings, because of that all version info internally is now being represented as tuples and not strings\n as before\n\n**Bugfixes**:\n\n- Stop raising `ResourceAttrError` for attributes that actually exist, but their value is `None`\n (`Issue #261 <https://github.com/maxtepkeev/python-redmine/pull/261>`__)\n- *Pro Edition:* RedmineUP Deal resource ``related_contacts`` attribute was returned as a list instead of being converted to\n ResourceSet object\n- Project resource ``default_assignee`` attribute was returned as a dict instead of being converted to\n Resource object\n- Project resource ``time_entry_activities`` attribute was returned as a list instead of being converted to\n ResourceSet object\n\n**Documentation**:\n\n- Document requirement of `project_id` param for `query_id` filter (`Issue #285 <https://github.com/maxtepkeev/\n python-redmine/pull/285>`__) (thanks to `Doezer <https://github.com/Doezer>`__)\n- Mentioned support for ``user_id`` in TimeEntry's resource create/update (`Issue #298 <https://github.com/\n maxtepkeev/python-redmine/issues/298>`__)\n- Mentioned support for additional scopes for Search API\n\n2.3.0 (2020-05-21)\n++++++++++++++++++\n\n**Deprecations**:\n\n- Requests version required >= 2.23.0\n- Removed Python 3.4 support as it's not supported by Requests anymore\n\n**Improvements**:\n\n- Support custom filename in ``redmine.upload()``\n- Support for ``get()`` and ``update()`` operations for ``/my/account`` endpoint which doesn't require admin\n privileges by using ``me`` as an id, i.e. ``redmine.user.get('me')`` or ``redmine.user.update('me',firstname='John')``\n (requires Redmine >= 4.1.0)\n- News ``create()``, ``update()``, ``delete()`` operations support (requires Redmine >= 4.1.0)\n- ResourceSet's ``export()`` method now supports ``columns`` keyword argument which can be either an iterable\n of column names, an \"all\" string which tells Python-Redmine to export all available columns, \"all_gui\" string\n for GUI like behaviour or iterable of elements with \"all_gui\" string and additional columns to export\n- Added support for special characters in WikiPage titles (`Issue #222 <https://github.com/maxtepkeev/python-redmine/\n issues/222>`__) (thanks to `Radek Czajka <https://github.com/rczajka>`__)\n- Added ``return_response`` and ``ignore_response`` parameters to engine which allow to skip response processing\n and speed up the create/update/delete operation in case response body isn't needed (see\n `docs <https://python-redmine.com/advanced/request_engines.html#session>`__ for details)\n\n**Bugfixes**:\n\n- User's ``send_information`` field wasn't sent correctly to Redmine so account information emails were\n never sent (`Issue #227 <https://github.com/maxtepkeev/python-redmine/pull/227>`__) (thanks to\n `wodny <https://github.com/wodny>`__)\n- Project resource ``default_version`` attribute was returned as a dict instead of being converted to\n Resource object\n- Resource object was leaking memory during initialization (`Issue #257 <https://github.com/maxtepkeev/python-redmine/\n issues/257>`__) (thanks to `yihli <https://github.com/qianyi3210>`__)\n\n**Documentation**:\n\n- Introduced detailed parameter list for ``redmine.session``\n- Mentioned support for ``admin`` in User's resource create/update\n\n2.2.1 (2019-02-28)\n++++++++++++++++++\n\n**Bugfixes**:\n\n- ProjectMembership resource ``group`` attribute was returned as a dict instead of being converted to\n Resource object (`Issue #220 <https://github.com/maxtepkeev/python-redmine/issues/220>`__) (thanks\n to `Samuel Harmer <https://github.com/samuelharmer>`__)\n\n2.2.0 (2019-01-13)\n++++++++++++++++++\n\n**Deprecations**:\n\n- Removed vendored Requests package and make it an external dependency as Requests did\n the same with its own dependencies\n- Removed Python 2.6 and 3.3 support as they're not supported by Requests anymore\n\n**Improvements**:\n\n- ``PerformanceWarning`` will be issued when Python-Redmine does some unnecessary work under the hood to fix the\n clients code problems\n\n**Bugfixes**:\n\n- ``Redmine.upload()`` fails under certain circumstances when used with a file-like object and it contains unicode\n instead of bytes (`Issue #216 <https://github.com/maxtepkeev/python-redmine/issues/216>`__)\n- ``Redmine.session()`` doesn't restore previous engine if fails (`Issue #211 <https://github.com/maxtepkeev/\n python-redmine/issues/211>`__) (thanks to `Dmitry Logvinenko <https://github.com/dm-logv>`__)\n\n2.1.1 (2018-05-02)\n++++++++++++++++++\n\n- Fix PyPI package\n\n2.1.0 (2018-05-02)\n++++++++++++++++++\n\nThis release concentrates mostly on stability and adds small features here and there. Some of them\nare backwards incompatible and are marked as such. They shouldn't affect many users since most of\nthem were used internally by Python-Redmine. A support for the Files API has been finally added, but\nplease be sure to check its documentation as the implementation on the Redmine side is horrible and\nthere are things to keep in mind while working with Files API. Lastly, only until the end of May 2018\nthere is a chance to buy a Pro Edition for only 14.99$ instead of the usual 24.99$, this is your\nchance to get an edition with additional features for a good price and to support the further development\nof Python-Redmine, more info `here <https://python-redmine.com/editions.html#pro-edition>`_.\n\n**New Features**:\n\n- Files API support (`Issue #117 <https://github.com/maxtepkeev/python-redmine/issues/117>`__)\n\n**Improvements**:\n\n- *Backwards Incompatible:* ResourceSet's ``filter()`` method became more advanced. It is now possible\n to filter on all available resource attributes, to follow resource relationships and apply lookups to\n the filters (see `docs <https://python-redmine.com/introduction.html#methods>`__ for details)\n- ResourceManager class has been refactored:\n\n * ``manager_class`` attribute on the ``Resource`` class can now be used to assign a separate\n ``ResourceManager`` to a resource, that allows outsourcing a resource specific functionality to a\n separate manager class (see ``WikiPageManager`` as an example)\n * *Backwards Incompatible:* ``request()`` method has been removed\n * ``_construct_*_url()``, ``_prepare_*_request()``, ``_process_*_response()`` methods have been added\n for create, update and delete methods to allow a fine-grained control over these operations\n\n- Ability to upload file-like objects (`Issue #186 <https://github.com/maxtepkeev/python-redmine/issues/\n 186>`__) (thanks to `hjpotter92 <https://github.com/hjpotter92>`__)\n- Support for retrieving project's time entry activities (see `docs <https://python-redmine.com/resources/\n project.html#get>`__ for details)\n- Attachment ``update()`` operation support (requires Redmine >= 3.4.0)\n- ``Resource.save()`` now accepts ``**attrs`` that need to be changed/set and returns ``self`` instead of a\n boolean ``True``, which makes it chainable, so you can now do something like ``project.save(name='foo',\n description='bar').export('txt', '/home/foo')``\n- ``get`` operation support for News, Query, Enumeration, IssueStatus, Tracker, CustomField, ContactTag,\n DealStatus, DealCategory and CRMQuery resources\n- ``include`` param in ``get``, ``all`` and ``filter`` operations now accepts lists and tuples instead of\n comma-separated string which is still accepted for backward compatibility reasons, i.e. one can use\n ``include=['foo', 'bar']`` instead of ``include='foo,bar'``\n- It is now possible to use ``None`` and ``0`` in addition to ``''`` in ``assigned_to_id`` attribute in\n Issue resource if an assignee needs to be removed from an issue\n\n**Changes**:\n\n- *Backwards Incompatible:* Issue ``all`` operation now really returns all issues, i.e. both open and closed,\n instead of only returning open issues in previous versions due to the respect to Redmine's standard behaviour\n- *Backwards Incompatible:* Instead of only returning a token string, ``upload()`` method was modified to return\n a dict that contains all the data for an upload returned from Redmine, i.e. id and token for Redmine >= 3.4.0,\n token only for Redmine < 3.4.0. Also it is now possible to use this token and pass it using a ``token`` key\n instead of the ``path`` key with path to the file in ``uploads`` parameter when doing an upload, this gives\n more control over the uploading process if needed\n- *Backwards Incompatible:* Removed ``resource_paths`` argument from Redmine object since ``ResourceManager``\n now uses a special resource registry, to which, all resources that inherit from any Python-Redmine resource\n are being automatically added\n- *Backwards Incompatible:* Removed ``container_many`` in favor of ``container_filter``, ``container_create``\n and ``container_update`` attributes on ``Resource`` object to allow more fine-grained resource setup\n- *Backwards Incompatible:* ``return_raw`` parameter on ``engine.request()`` and ``engine.process_response()``\n methods has been removed in favor of ``return_raw_response`` attribute on engine object\n- Updated bundled requests library to v2.15.1\n\n**Bugfixes**:\n\n- Support 204 status code when deleting a resource (`Issue #189 <https://github.com/maxtepkeev/python-redmine/\n pull/189>`__) (thanks to `dotSlashLu <https://github.com/dotSlashLu>`__)\n- Raise ``ValidationError`` instead of not helpful ``TypeError`` exception when trying to create a WikiPage\n resource that already exists (`Issue #182 <https://github.com/maxtepkeev/python-redmine/issues/182>`__)\n- Enumeration, Version, Group and Notes ``custom_fields`` attribute was returned as a list of dicts instead\n of being converted to ``ResourceSet`` object\n- Downloads were downloaded fully into memory instead of being streamed as needed\n- ``ResourceRequirementsError`` exception was broken since v2.0.0\n- *Pro Edition:* RedmineUP CRM Contact and Deal resources export functionality didn't work\n- *Pro Edition:* RedmineUP CRM Contact and Deal resources sometimes weren't converted to Resource objects using Search API\n\n**Documentation**:\n\n- Mentioned support for ``generate_password`` and ``send_information`` in User's resource create/update\n methods, ``status`` in User's resource update method, ``parent_id`` in Issue's filter method and ``include``\n in Issue's all method\n\n2.0.2 (2017-04-19)\n++++++++++++++++++\n\n**Bugfixes**:\n\n- Filter doesn't work when there are > 100 resources requested (`Issue #175 <https://github.com/maxtepkeev/\n python-redmine/pull/175>`__) (thanks to `niwatolli3 <https://github.com/niwatolli3>`__)\n\n2.0.1 (2017-04-10)\n++++++++++++++++++\n\n- Fix PyPI package\n\n2.0.0 (2017-04-10)\n++++++++++++++++++\n\nThis version brings a lot of new features and changes, some of them are backward-incompatible, so please\nlook carefully at the changelog below to find out what needs to be changed in your code to make it work\nwith this version. Also Python-Redmine now comes in 2 editions: Standard and Pro, please have a look at\nthis `document <https://python-redmine.com/editions.html>`__ for more details. Documentation was\nalso significantly rewritten, so it is recommended to reread it even if you are an experienced Python-Redmine\nuser.\n\n**New Features**:\n\n- *Pro Edition:* RedmineUP `Checklist plugin <https://www.redmineup.com/pages/plugins/checklists>`__ support\n- `Request Engines <https://python-redmine.com/advanced/request_engines.html>`__ support. It is\n now possible to create engines to define how requests to Redmine are made, e.g. synchronous (one by one)\n or asynchronous using threads or processes etc\n- ``redmine.session()`` context manager which allows to temporary redefine engine's behaviour\n- Search API support (`Issue #138 <https://github.com/maxtepkeev/python-redmine/issues/138>`__)\n- Export functionality (`Issue #58 <https://github.com/maxtepkeev/python-redmine/issues/58>`__)\n- REDMINE_USE_EXTERNAL_REQUESTS environmental variable for emergency cases which allows to use external\n requests instead of bundled one even if external requests version is lower than the bundled one\n- Wrong HTTP protocol usage detector, e.g. one use HTTP when HTTPS should be used\n\n**Improvements**:\n\n- ResourceSet objects were completely rewritten:\n\n * ``ResourceSet`` object that was already sliced now supports reslicing\n * ``ResourceSet`` object's ``delete()``, ``update()``, ``filter()`` and ``get()`` methods have been\n optimized for speed\n * ``ResourceSet`` object's ``delete()`` and ``update()`` methods now call the corresponding Resource's\n ``pre_*()`` and ``post_*()`` methods\n * ``ResourceSet`` object's ``get()`` and ``filter()`` methods now supports non-integer id's, e.g.\n WikiPage's title can now be used with it\n * *Backwards Incompatible:* ``ValuesResourceSet`` class has been removed\n * *Backwards Incompatible:* ``ResourceSet.values()`` method now returns an iterable of dicts instead of\n ``ValuesResourceSet`` object\n * ``ResourceSet.values_list()`` method has been added which returns an iterable of tuples with Resource\n values or single values if flattened, i.e. ``flat=True``\n\n- New ``Resource`` object methods:\n\n * ``delete()`` deletes current resource from Redmine\n * ``pre_delete()`` and ``post_delete()`` can be used to execute tasks that should be done before/after\n deleting the resource through ``delete()`` method\n * ``bulk_decode()``, ``bulk_encode()``, ``decode()`` and ``encode()`` which are used to translate\n attributes of the resource to/from Python/Redmine\n\n- Attachment ``delete()`` method support (requires Redmine >= 3.3.0)\n- *Pro Edition:* RedmineUP CRM Note resource now provides ``type`` attribute which shows text representation of ``type_id``\n- *Pro Edition:* RedmineUP CRM DealStatus resource now provides ``status`` attribute which shows text representation of\n ``status_type``\n- WikiPage resource now provides ``project_id`` attribute\n- Unicode handling was significantly rewritten and shouldn't cause any more troubles\n- ``UnknownError`` exception now contains ``status_code`` attribute which can be used to handle the\n exception instead of parsing code from exception's text\n- Sync engine's speed improved to 8-12% depending on the amount of resources fetched\n\n**Changes**:\n\n- *Backwards Incompatible:* Renamed package name from ``redmine`` to ``redminelib``\n- Resource class attributes that were previously tuples are now lists\n- *Backwards Incompatible:* ``_Resource`` class renamed to ``Resource``\n- *Backwards Incompatible:* ``Redmine.custom_resource_paths`` keyword argument renamed to ``resource_paths``\n- *Backwards Incompatible:* ``Redmine.download()`` method now returns a `requests.Response\n <http://docs.python-requests.org/en/latest/api/#requests.Response>`__ object directly instead of\n ``iter_content()`` method if a ``savepath`` param wasn't provided, this gives user even more control over\n response data\n- *Backwards Incompatible:* ``Resource.refresh()`` now really refreshes itself instead of returning a new\n refreshed resource, to get the previous behaviour use ``itself`` param, e.g. ``Resource.refresh(itself=False)``\n- *Backwards Incompatible:* Removed Python 3.2 support\n- *Backwards Incompatible:* Removed ``container_filter``, ``container_create`` and ``container_update`` attributes\n on ``Resource`` object in favor of ``container_many`` attribute\n- *Backwards Incompatible:* Removed ``Resource.translate_params()`` and ``ResourceManager.prepare_params()`` in\n favor of ``Resource.bulk_decode()``\n- *Backwards Incompatible:* Removed ``is_unicode()``, ``is_string()`` and ``to_string()`` from\n ``redminelib.utilities``\n- Updated bundled requests library to v2.13.0\n\n**Bugfixes**:\n\n- Infinite loop when uploading zero-length files (`Issue #152 <https://github.com/maxtepkeev/python-redmine/\n issues/152>`__)\n- Unsupported Redmine resource error while trying to use Python-Redmine without installation (`Issue #156\n <https://github.com/maxtepkeev/python-redmine/issues/156>`__)\n- It was impossible to set ``data``, ``params`` and ``headers`` via ``requests`` keyword argument on\n Redmine object\n- Calling ``str()`` or ``repr()`` on a Resource was giving incorrect results if exception raising\n was turned off for a resource\n\n**Documentation**:\n\n- Switched to the alabaster theme\n- Added new sections:\n\n * `Editions <https://python-redmine.com/editions.html>`__\n * `Introduction <https://python-redmine.com/introduction.html>`__\n * `Request Engines <https://python-redmine.com/advanced/request_engines.html>`__\n\n- Added info about Issue Journals (`Issue #120 <https://github.com/maxtepkeev/python-redmine/issues/120>`__)\n- Added note about open/closed issues (`Issue #136 <https://github.com/maxtepkeev/python-redmine/issues/136>`__)\n- Added note about regexp custom field filter (`Issue #164 <https://github.com/maxtepkeev/python-redmine/\n issues/164>`__)\n- Added some new information here and there\n\n1.5.1 (2016-03-27)\n++++++++++++++++++\n\n- Changed: Updated bundled requests package to 2.9.1\n- Changed: `Issue #124 <https://github.com/maxtepkeev/python-redmine/issues/124>`__ (``project.url``\n now uses ``identifier`` rather than ``id`` to generate url for the project resource)\n- Fixed: `Issue #122 <https://github.com/maxtepkeev/python-redmine/issues/122>`__ (``ValidationError`` for\n empty custom field values was possible under some circumstances with Redmine < 2.5.0)\n- Fixed: `Issue #112 <https://github.com/maxtepkeev/python-redmine/issues/112>`__ (``UnicodeEncodeError``\n on Python 2 if ``resource_id`` was of ``unicode`` type) (thanks to `Digenis <https://github.com/Digenis>`__)\n\n1.5.0 (2015-11-26)\n++++++++++++++++++\n\n- Added: Documented support for new fields and values in User, Issue and IssueRelation resources\n- Added: `Issue #109 <https://github.com/maxtepkeev/python-redmine/issues/109>`__ (Smart imports for\n vendored packages (see `docs <https://python-redmine.com/installation.html#dependencies>`__\n for details)\n- Added: `Issue #115 <https://github.com/maxtepkeev/python-redmine/issues/115>`__ (File upload support\n for WikiPage resource)\n\n1.4.0 (2015-10-18)\n++++++++++++++++++\n\n- Added: `Requests <http://docs.python-requests.org>`__ is now embedded into Python-Redmine\n- Added: Python-Redmine is now embeddable to other libraries\n- Fixed: Previous release was broken on PyPI\n\n1.3.0 (2015-10-18)\n++++++++++++++++++\n\n- Added: `Issue #108 <https://github.com/maxtepkeev/python-redmine/issues/108>`__ (Tests are now\n built-in into source package distributed via PyPI)\n\n1.2.0 (2015-07-09)\n++++++++++++++++++\n\n- Added: `wheel <http://wheel.readthedocs.io>`__ support\n- Added: `Issue #93 <https://github.com/maxtepkeev/python-redmine/issues/93>`__ (``JSONDecodeError``\n exception now contains a ``response`` attribute which can be inspected to identify the cause of the\n exception)\n- Added: `Issue #98 <https://github.com/maxtepkeev/python-redmine/issues/98>`__ (Support for setting\n WikiPage resource parent title and converting parent attribute to Resource object instead of being\n a dict)\n\n1.1.2 (2015-05-20)\n++++++++++++++++++\n\n- Fixed: `Issue #90 <https://github.com/maxtepkeev/python-redmine/issues/90>`__ (Python-Redmine\n fails to install on systems with LC_ALL=C) (thanks to `spikergit1 <https://github.com/spikergit1>`__)\n\n1.1.1 (2015-03-26)\n++++++++++++++++++\n\n- Fixed: `Issue #85 <https://github.com/maxtepkeev/python-redmine/issues/85>`__ (Python-Redmine\n was trying to convert field to date/datetime even when it shouldn't, i.e. if a field looked like\n YYYY-MM-DD but wasn't actually a date/datetime field, e.g. wiki page title or issue subject)\n\n1.1.0 (2015-02-20)\n++++++++++++++++++\n\n- Added: PyPy2/3 is now officially supported\n- Added: Introduced ``enabled_modules`` on demand include in Project resource\n- Fixed: `Issue #78 <https://github.com/maxtepkeev/python-redmine/issues/78>`__ (Redmine <2.5.2\n returns only single tracker instead of a list of all available trackers when requested from\n a CustomField resource which caused an Exception in Python-Redmine, see `this <http://www.\n redmine.org/issues/16739>`__ for details)\n- Fixed: `Issue #80 <https://github.com/maxtepkeev/python-redmine/issues/80>`__ (If a project\n is read-only or doesn't have CRM plugin enabled, an attempt to add/remove Contact resource\n to/from it will lead to improper error message)\n- Fixed: `Issue #81 <https://github.com/maxtepkeev/python-redmine/issues/81>`__ (Contact's\n resource ``tag_list`` attribute was always splitted into single chars) (thanks to `Alexander\n Loechel <https://github.com/loechel>`__)\n\n1.0.3 (2015-02-03)\n++++++++++++++++++\n\n- Fixed: `Issue #72 <https://github.com/maxtepkeev/python-redmine/issues/72>`__ (If an exception is\n raised during JSON decoding process, it should be catched and reraised as Python-Redmine's own\n exception, i.e ``redmine.exceptions.JSONDecodeError``)\n- Fixed: `Issue #76 <https://github.com/maxtepkeev/python-redmine/issues/76>`__ (It was impossible\n to retrieve more than 100 resources for resources which don't support limit/offset natively by\n Redmine, i.e. this functionality is emulated by Python-Redmine, e.g. WikiPage, Groups, Roles etc)\n\n1.0.2 (2014-11-13)\n++++++++++++++++++\n\n- Fixed: `Issue #55 <https://github.com/maxtepkeev/python-redmine/issues/55>`__ (TypeError was\n raised during processing validation errors from Redmine when one of the errors was returned as\n a list)\n- Fixed: `Issue #59 <https://github.com/maxtepkeev/python-redmine/issues/59>`__ (Raise ForbiddenError\n when a 403 is encountered) (thanks to `Rick Harris <https://github.com/rconradharris>`__)\n- Fixed: `Issue #64 <https://github.com/maxtepkeev/python-redmine/issues/64>`__ (Redmine and Resource\n classes weren't picklable) (thanks to `Rick Harris <https://github.com/rconradharris>`__)\n- Fixed: A ResourceSet object with a limit=100, actually returned 125 Resource objects\n\n1.0.1 (2014-09-23)\n++++++++++++++++++\n\n- Fixed: `Issue #50 <https://github.com/maxtepkeev/python-redmine/issues/50>`__ (IssueJournal's\n ``notes`` attribute was converted to Note resource by mistake, bug was introduced in v1.0.0)\n\n1.0.0 (2014-09-22)\n++++++++++++++++++\n\n- Added: Support for the `CRM plugin <https://www.redmineup.com/pages/plugins/crm>`__ resources:\n\n * `Contact <https://python-redmine.com/resources/contact.html>`__\n * `ContactTag <https://python-redmine.com/resources/contact_tag.html>`__\n * `Note <https://python-redmine.com/resources/note.html>`__\n * `Deal <https://python-redmine.com/resources/deal.html>`__\n * `DealStatus <https://python-redmine.com/resources/deal_status.html>`__\n * `DealCategory <https://python-redmine.com/resources/deal_category.html>`__\n * `CrmQuery <https://python-redmine.com/resources/crm_query.html>`__\n\n- Added: Introduced new relations for the following resource objects:\n\n * Project - time_entries, deals, contacts and deal_categories relations\n * User - issues, time_entries, deals and contacts relations\n * Tracker - issues relation\n * IssueStatus - issues relation\n\n- Added: Introduced a ``values()`` method in a ResourceSet which returns ValuesResourceSet - a\n ResourceSet subclass that returns dictionaries when used as an iterable, rather than resource-instance\n objects (see `docs <https://python-redmine.com/introduction.html#methods>`__ for details)\n- Added: Introduced ``update()`` and ``delete()`` methods in a ResourceSet object which allow to\n bulk update or bulk delete all resources in a ResourceSet object (see\n `docs <https://python-redmine.com/introduction.html#methods>`__ for details)\n- Fixed: It was impossible to use ResourceSet's ``get()`` and ``filter()`` methods with WikiPage\n resource\n- Fixed: Several small fixes and enhancements here and there\n\n0.9.0 (2014-09-11)\n++++++++++++++++++\n\n- Added: Introduced support for file downloads (see\n `docs <https://python-redmine.com/advanced/working_with_files.html>`__ for details)\n- Added: Introduced new ``_Resource.requirements`` class attribute where all Redmine plugins\n required by resource should be listed (preparations to support non-native resources)\n- Added: New exceptions:\n\n * ResourceRequirementsError\n\n- Fixed: It was impossible to set a custom field of date/datetime type using date/datetime\n Python objects\n- Fixed: `Issue #46 <https://github.com/maxtepkeev/python-redmine/issues/46>`__\n (A UnicodeEncodeError was raised in Python 2.x while trying to access a ``url`` property of\n a WikiPage resource if it contained non-ascii characters)\n\n0.8.4 (2014-08-08)\n++++++++++++++++++\n\n- Added: Support for anonymous Attachment resource (i.e. attachment with ``id`` attr only)\n- Fixed: `Issue #42 <https://github.com/maxtepkeev/python-redmine/issues/42>`__ (It was\n impossible to create a Project resource via ``new()`` method)\n\n0.8.3 (2014-08-01)\n++++++++++++++++++\n\n- Fixed: `Issue #39 <https://github.com/maxtepkeev/python-redmine/issues/39>`__ (It was\n impossible to save custom_fields in User resource via ``new()`` method)\n\n0.8.2 (2014-05-27)\n++++++++++++++++++\n\n- Added: ResourceSet's ``get()`` method now supports a ``default`` keyword argument which is\n returned when a requested Resource can't be found in a ResourceSet and defaults to ``None``,\n previously this was hardcoded to ``None``\n- Added: It is now possible to use ``getattr()`` with default value without raising a\n ``ResourceAttrError`` when calling non-existent resource attribute, see `Issue #30\n <https://github.com/maxtepkeev/python-redmine/issues/30>`__ for details (thanks to\n `hsum <https://github.com/hsum>`__)\n- Fixed: `Issue #31 <https://github.com/maxtepkeev/python-redmine/issues/31>`__ (Unlimited\n recursion was possible in some situations when on demand includes were used)\n\n0.8.1 (2014-04-02)\n++++++++++++++++++\n\n- Added: New exceptions:\n\n * RequestEntityTooLargeError\n * UnknownError\n\n- Fixed: `Issue #27 <https://github.com/maxtepkeev/python-redmine/issues/27>`__ (Project and\n Issue resources ``parent`` attribute was returned as a dict instead of being converted to\n Resource object)\n\n0.8.0 (2014-03-27)\n++++++++++++++++++\n\n- Added: Introduced the detection of conflicting packages, i.e. if a conflicting package is\n found (PyRedmineWS at this time is the only one), the installation procedure will be aborted\n and a warning message will be shown with the detailed description of the problem\n- Added: Introduced new ``_Resource._members`` class attribute where all instance attributes\n which are not started with underscore should be listed. This will resolve recursion issues\n in custom resources because of how ``__setattr__()`` works in Python\n- Changed: ``_Resource.attributes`` renamed to ``_Resource._attributes``\n- Fixed: Python-Redmine was unable to upload any binary files\n- Fixed: `Issue #20 <https://github.com/maxtepkeev/python-redmine/issues/20>`__ (Lowered\n Requests version requirements. Python-Redmine now requires Requests starting from 0.12.1\n instead of 2.1.0 in previous versions)\n- Fixed: `Issue #23 <https://github.com/maxtepkeev/python-redmine/issues/23>`__ (File uploads\n via ``update()`` method didn't work)\n\n0.7.2 (2014-03-17)\n++++++++++++++++++\n\n- Fixed: `Issue #19 <https://github.com/maxtepkeev/python-redmine/issues/19>`__ (Resources\n obtained via ``filter()`` and ``all()`` methods have incomplete url attribute)\n- Fixed: Redmine server url with forward slash could cause errors in rare cases\n- Fixed: Python-Redmine was incorrectly raising ``ResourceAttrError`` when trying to call\n ``repr()`` on a News resource\n\n0.7.1 (2014-03-14)\n++++++++++++++++++\n\n- Fixed: `Issue #16 <https://github.com/maxtepkeev/python-redmine/issues/16>`__ (When a resource\n was created via a ``new()`` method, the next resource created after that inherited all the\n attribute values of the previous resource)\n\n0.7.0 (2014-03-12)\n++++++++++++++++++\n\n- Added: WikiPage resource now automatically requests all of its available attributes from\n Redmine in case if some of them are not available in an existent resource object\n- Added: Support for setting date/datetime resource attributes using date/datetime Python objects\n- Added: Support for using date/datetime Python objects in all ResourceManager methods, i.e.\n ``new()``, ``create()``, ``update()``, ``delete()``, ``get()``, ``all()``, ``filter()``\n- Fixed: `Issue #14 <https://github.com/maxtepkeev/python-redmine/issues/14>`__ (Python-Redmine\n was incorrectly raising ``ResourceAttrError`` when trying to call ``repr()``, ``str()`` and\n ``int()`` on resources, created via ``new()`` method)\n\n0.6.2 (2014-03-09)\n++++++++++++++++++\n\n- Fixed: Project resource ``status`` attribute was converted to IssueStatus resource by mistake\n\n0.6.1 (2014-02-27)\n++++++++++++++++++\n\n- Fixed: `Issue #10 <https://github.com/maxtepkeev/python-redmine/issues/10>`__ (Python\n Redmine was incorrectly raising ``ResourceAttrError`` while creating some resources via\n ``new()`` method)\n\n0.6.0 (2014-02-19)\n++++++++++++++++++\n\n- Added: ``Redmine.auth()`` shortcut for the case if we just want to check if user provided\n valid auth credentials, can be used for user authentication on external resource based on\n Redmine user database (see `docs <https://python-redmine.com/advanced/external_auth.html>`__\n for details)\n- Fixed: ``JSONDecodeError`` was raised in some Redmine versions during some create/update\n operations (thanks to `0x55aa <https://github.com/0x55aa>`__)\n- Fixed: User resource ``status`` attribute was converted to IssueStatus resource by mistake\n\n0.5.0 (2014-02-09)\n++++++++++++++++++\n\n- Added: An ability to create custom resources which allow to easily redefine the behaviour\n of existing resources (see `docs <https://python-redmine.com/advanced/custom_resources.html>`__\n for details)\n- Added: An ability to add/remove watcher to/from issue (see `docs\n <https://python-redmine.com/resources/issue.html#watchers>`__ for details)\n- Added: An ability to add/remove users to/from group (see `docs\n <https://python-redmine.com/resources/group.html#users>`__ for details)\n\n0.4.0 (2014-02-08)\n++++++++++++++++++\n\n- Added: New exceptions:\n\n * ConflictError\n * ReadonlyAttrError\n * ResultSetTotalCountError\n * CustomFieldValueError\n\n- Added: Update functionality via ``update()`` and ``save()`` methods for resources (see\n `docs <https://python-redmine.com/introduction.html#update>`__ for details):\n\n * User\n * Group\n * IssueCategory\n * Version\n * TimeEntry\n * ProjectMembership\n * WikiPage\n * Project\n * Issue\n\n- Added: Limit/offset support via ``all()`` and ``filter()`` methods for resources that\n doesn't support that feature via Redmine:\n\n * IssueRelation\n * Version\n * WikiPage\n * IssueStatus\n * Tracker\n * Enumeration\n * IssueCategory\n * Role\n * Group\n * CustomField\n\n- Added: On demand includes, e.g. in addition to ``redmine.group.get(1, include='users')``\n users for a group can also be retrieved on demand via ``group.users`` if include wasn't set\n (see `docs <https://python-redmine.com/resources/index.html>`__ for details)\n- Added: ``total_count`` attribute to ResourceSet object which holds the total number\n of resources for the current resource type available in Redmine (thanks to\n `Andrei Avram <https://github.com/andreiavram>`__)\n- Added: An ability to return ``None`` instead of raising a ``ResourceAttrError`` for all\n or selected resource objects via ``raise_attr_exception`` kwarg on Redmine object (see\n `docs <https://python-redmine.com/configuration.html#exception-control>`__ for\n details or `Issue #6 <https://github.com/maxtepkeev/python-redmine/issues/6>`__)\n- Added: ``pre_create()``, ``post_create()``, ``pre_update()``, ``post_update()`` resource\n object methods which can be used to execute tasks that should be done before/after\n creating/updating the resource through ``save()`` method\n- Added: Allow to create resources in alternative way via ``new()`` method (see `docs\n <https://python-redmine.com/introduction.html#new>`__ for details)\n- Added: Allow daterange TimeEntry resource filtering via ``from_date`` and ``to_date``\n keyword arguments (thanks to `Antoni Aloy <https://github.com/aaloy>`__)\n- Added: An ability to retrieve Issue version via ``version`` attribute in addition to\n ``fixed_version`` to be more obvious\n- Changed: Documentation for resources rewritten from scratch to be more understandable\n- Fixed: Saving custom fields to Redmine didn't work in some situations\n- Fixed: Issue's ``fixed_version`` attribute was retrieved as dict instead of Version resource\n object\n- Fixed: Resource relations were requested from Redmine every time instead of caching the\n result after first request\n- Fixed: `Issue #2 <https://github.com/maxtepkeev/python-redmine/issues/2>`__ (limit/offset\n as keyword arguments were broken)\n- Fixed: `Issue #5 <https://github.com/maxtepkeev/python-redmine/issues/5>`__ (Version\n resource ``status`` attribute was converted to IssueStatus resource by mistake) (thanks\n to `Andrei Avram <https://github.com/andreiavram>`__)\n- Fixed: A lot of small fixes, enhancements and refactoring here and there\n\n0.3.1 (2014-01-23)\n++++++++++++++++++\n\n- Added: An ability to pass Requests parameters as a dictionary via ``requests`` keyword\n argument on Redmine initialization, i.e. Redmine('\\http://redmine.url', requests={}).\n- Fixed: `Issue #1 <https://github.com/maxtepkeev/python-redmine/issues/1>`__ (unable\n to connect to Redmine server with invalid ssl certificate).\n\n0.3.0 (2014-01-18)\n++++++++++++++++++\n\n- Added: Delete functionality via ``delete()`` method for resources (see `docs\n <https://python-redmine.com/introduction.html#delete>`__ for details):\n\n * User\n * Group\n * IssueCategory\n * Version\n * TimeEntry\n * IssueRelation\n * ProjectMembership\n * WikiPage\n * Project\n * Issue\n\n- Changed: ResourceManager ``get()`` method now raises a ``ValidationError`` exception if\n required keyword arguments aren't passed\n\n0.2.0 (2014-01-16)\n++++++++++++++++++\n\n- Added: New exceptions:\n\n * ServerError\n * NoFileError\n * ValidationError\n * VersionMismatchError\n * ResourceNoFieldsProvidedError\n * ResourceNotFoundError\n\n- Added: Create functionality via ``create()`` method for resources (see `docs\n <https://python-redmine.com/introduction.html#id1>`__ for details):\n\n * User\n * Group\n * IssueCategory\n * Version\n * TimeEntry\n * IssueRelation\n * ProjectMembership\n * WikiPage\n * Project\n * Issue\n\n- Added: File upload support, see ``upload()`` method in Redmine class\n- Added: Integer representation to all resources, i.e. ``__int__()``\n- Added: Informal string representation to all resources, i.e. ``__str__()``\n- Changed: Renamed ``version`` attribute to ``redmine_version`` in all resources to avoid\n name intersections\n- Changed: ResourceManager ``get()`` method now raises a ``ResourceNotFoundError`` exception\n if resource wasn't found instead of returning None in previous versions\n- Changed: reimplemented fix for ``__repr__()`` from 0.1.1\n- Fixed: Conversion of issue priorities to enumeration resource object didn't work\n\n0.1.1 (2014-01-10)\n++++++++++++++++++\n\n- Added: Python 2.6 support\n- Changed: WikiPage resource ``refresh()`` method now automatically determines its project_id\n- Fixed: Resource representation, i.e. ``__repr__()``, was broken in Python 2.7\n- Fixed: ``dir()`` call on a resource object didn't work in Python 3.2\n\n0.1.0 (2014-01-09)\n++++++++++++++++++\n\n- Initial release\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Library for communicating with a Redmine project management application",
"version": "2.5.0",
"project_urls": {
"Documentation": "https://python-redmine.com",
"Homepage": "https://github.com/maxtepkeev/python-redmine"
},
"split_keywords": [
"redmine",
"redmineup",
"redminecrm",
"redminelib",
"easyredmine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf3afd9b3edd21e8684f99af219c713274cd1b132d98da999489f48c85037393",
"md5": "3502e941cf41eb992bf50f964f7e25ce",
"sha256": "4b9c1dbcf46f96bed963ab48eab432f06c7ae342df9751d04cb54d268e2e8055"
},
"downloads": -1,
"filename": "python_redmine-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3502e941cf41eb992bf50f964f7e25ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 39635,
"upload_time": "2024-03-31T15:24:18",
"upload_time_iso_8601": "2024-03-31T15:24:18.874719Z",
"url": "https://files.pythonhosted.org/packages/bf/3a/fd9b3edd21e8684f99af219c713274cd1b132d98da999489f48c85037393/python_redmine-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18b3c4d0500d81452d0e2296d53ccbc1c18cbea7a1e7dfc8b64935513b915a8f",
"md5": "39eae11746d7e3c466abf95855e1d01c",
"sha256": "81bdc529aaf188658e2d07488096c795d03d4e256711bfa3fa3f17b1eecc471b"
},
"downloads": -1,
"filename": "python-redmine-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "39eae11746d7e3c466abf95855e1d01c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 73643,
"upload_time": "2024-03-31T15:24:22",
"upload_time_iso_8601": "2024-03-31T15:24:22.208869Z",
"url": "https://files.pythonhosted.org/packages/18/b3/c4d0500d81452d0e2296d53ccbc1c18cbea7a1e7dfc8b64935513b915a8f/python-redmine-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-31 15:24:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxtepkeev",
"github_project": "python-redmine",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "python-redmine"
}
JSON
