https://github.com/maxtepkeev/python-redmine

Python Redmine is a library for communicating with a Redmine project management application
https://github.com/maxtepkeev/python-redmine

api-client python redmine redminecrm redmineup

Last synced: 3 days ago
JSON representation

Python Redmine is a library for communicating with a Redmine project management application

• Host: GitHub
• URL: https://github.com/maxtepkeev/python-redmine
• Owner: maxtepkeev
• License: other
• Created: 2014-01-09T11:14:13.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T17:39:38.000Z (11 months ago)
• Last Synced: 2024-05-16T18:36:25.009Z (11 months ago)
• Topics: api-client, python, redmine, redminecrm, redmineup
• Language: Python
• Homepage:
• Size: 1.96 MB
• Stars: 532
• Watchers: 34
• Forks: 118
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-redmine - python-redmine - Python Redmine is a library for communicating with a Redmine project management application. (API wrapper / Commercial Themes)

README

        
Python-Redmine

==============

|PyPI| |Tests| |Coveralls|

.. |PyPI| image:: https://badge.fury.io/py/python-redmine.svg

   :target: https://badge.fury.io/py/python-redmine

.. |Tests| image:: https://img.shields.io/github/actions/workflow/status/maxtepkeev/python-redmine/tests.yml.svg

   :target: https://github.com/maxtepkeev/python-redmine/actions/workflows/tests.yml

.. |Coveralls| 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 `__

project management application. Redmine exposes some of its data via `REST API

`__ for which Python-Redmine provides

a simple but powerful Pythonic API inspired by a well-known `Django ORM

`__:

.. 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

   

   >>> project.issues[0]

   

   >>> 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

   

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 `__:

.. code-block:: bash

   $ pip install python-redmine

Pro Edition

+++++++++++

License for a Pro Edition can currently only be bought via `TON `__ by transferring 25 USDT

to the following wallet address: :code:`UQBn0FIZM1zM7lmIeCczdk9sIMDrvBfFbbuXsYJPdCaFcmYJ`. After the

transaction is complete, be sure to send an email to [email protected] that contains your transaction ID

and you will receive an email back with all the details regarding Pro Edition installation process. Please give us

at least 3 to 6 hours to process these emails.

Documentation

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

Documentation is available at https://python-redmine.com.

Contacts and Support

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

Support for Standard Edition is provided via `GitHub `__

only, while support for Pro Edition is provided both via `GitHub `__

and [email protected]. 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 `__

for details.