Package: snakemine
¶
A Pythonic interface to Redmine’s REST API.
Module author: Mark Lee <snakemine@lazymalevolence.com>
Subpackage¶
Base functionality (snakemine.base
)¶
Base for Redmine models.
Module author: Mark Lee <snakemine@lazymalevolence.com>
-
class
snakemine.base.
Manager
[source]¶ Bases:
object
A Django-like model manager for Redmine resources.
-
all
()[source]¶ Retrieves all of the available items for a given resource.
Return type: list
ofResource
-
create
(data)[source]¶ Creates a new
Resource
-derived object.Parameters: data (dict) – The new resource metadata Return type: Resource
-
-
class
snakemine.base.
Resource
(response)[source]¶ Bases:
object
An abstract representation of a Redmine resource.
Much like a Django model, a
Resource
typically has a class variable namedobjects
, which is an instantiation of the relatedManager
.Parameters: response – the object the represents the metadata of the resource item
Issue management (snakemine.issue
)¶
Handling of Redmine issues.
Module author: Mark Lee <snakemine@lazymalevolence.com>
-
class
snakemine.issue.
Issue
(response)[source]¶ Bases:
snakemine.base.Resource
A representation of a Redmine issue.
-
objects
= <snakemine.issue.IssueManager object>¶
-
project
¶ The
Project
associated with the issue.
-
-
class
snakemine.issue.
IssueManager
[source]¶ Bases:
snakemine.base.Manager
A Django-like model manager for Redmine issues.
Project management (snakemine.project
)¶
Handling of Redmine projects.
Module author: Mark Lee <snakemine@lazymalevolence.com>
-
class
snakemine.project.
Project
(response)[source]¶ Bases:
snakemine.base.Resource
A representation of a Redmine project.
-
objects
= <snakemine.project.ProjectManager object>¶
-
-
class
snakemine.project.
ProjectManager
[source]¶ Bases:
snakemine.base.Manager
A Django-like model manager for Redmine projects.