Package: snakemine

A Pythonic interface to Redmine’s REST API.

Module author: Mark Lee <snakemine@lazymalevolence.com>

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 of Resource
create(data)[source]

Creates a new Resource-derived object.

Parameters:data (dict) – The new resource metadata
Return type:Resource
delete(resource_id)[source]
filter(**kwargs)[source]
get(resource_id)[source]

Retrieves a single item for a given resource and ID.

Parameters:resource_id (int) – The resource’s ID
Return type:Resource
update(resource_id, data)[source]
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 named objects, which is an instantiation of the related Manager.

Parameters:response – the object the represents the metadata of the resource item
delete()[source]

Deletes the resource item from Redmine.

save()[source]

Creates or updates the resource item in Redmine.

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

The parent issue, if specified.

Return type:Issue or None
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.