Models documentation

Contents:

class taiga.models.models.Attachment(requester, **params)[source]

Bases: InstanceResource

Attachment base class

Parameters:

object_id – object_id of Attachment
project – project of Attachment
attached_file – attached_file of Attachment
description – description of Attachment
is_deprecated – is_deprecated of Attachment

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Attachments(requester)[source]

Bases: ListResource

Attachments factory base class

create(project, object_id, attached_file, **attrs)[source]

Create a new Attachment.

Parameters:

project – Project id
object_id – id of the current object
ref – Task reference
attached_file – file path that you want to upload
attrs – optional attributes for the Attachment

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.CommentableResource(requester, **params)[source]

Bases: InstanceResource

CommentableResource base class

add_comment(comment)[source]

Add a comment to the current element

Parameters:: comment – the comment you want to insert

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.CustomAttribute(requester, **params)[source]

Bases: InstanceResource

CustomAttribute base class

Parameters:

requester – Requester instance
name – name of the custom attribute
description – id of the current object
order – order of the custom attribute
project – Project id

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.CustomAttributeResource(requester, **params)[source]

Bases: InstanceResource

CustomAttributeResource base class

delete(query=None): Delete the current InstanceResource

get_attributes()[source]: Get all the attributes of the current object

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

set_attribute(id, value, version=1)[source]

Set attribute to a specific value

Parameters:

id – id of the attribute
value – value of the attribute
version – version of the attribute (default = 1)

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.CustomAttributes(requester)[source]

Bases: ListResource

CustomAttributes factory base class

create(project, name, **attrs)[source]

Create a new CustomAttribute.

Parameters:

project – Project id
name – name of the custom attribute
attrs – optional attributes of the custom attributes

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Epic(requester, **params)[source]

Bases: CustomAttributeResource, CommentableResource

Epic model

Parameters:

assigned_to – assigned to property of Epic
blocked_note – blocked note of Epic
description – description of Epic (not available in the Epics.list() response)
is_blocked – is blocked property of Epic
is_closed – is closed property of Epic
color – the color of Epic
project – the project of TaskStatus
subject – subject of TaskStatus
tags – tags of TaskStatus
watchers – watchers of TaskStatus
version – version of Epic

add_comment(comment)

Add a comment to the current element

Parameters:: comment – the comment you want to insert

attach(attached_file, **attrs)[source]

Attach a file to the Epic

Parameters:

attached_file – file path to attach
attrs – optional attributes for the attached file

delete(query=None): Delete the current InstanceResource

get_attributes(): Get all the attributes of the current object

list_attachments()[source]: Get a list of EpicAttachment.

list_user_stories(**queryparams)[source]: Returns the UserStory list of the project.

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

set_attribute(id, value, version=1)

Set attribute to a specific value

Parameters:

id – id of the attribute
value – value of the attribute
version – version of the attribute (default = 1)

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.EpicAttachment(requester, **params)[source]

Bases: Attachment

EpicAttachment class

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.EpicAttachments(requester)[source]

Bases: Attachments

EpicAttachments factory class

create(project, object_id, attached_file, **attrs)

Create a new Attachment.

Parameters:

project – Project id
object_id – id of the current object
ref – Task reference
attached_file – file path that you want to upload
attrs – optional attributes for the Attachment

instance: alias of EpicAttachment

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.EpicAttribute(requester, **params)[source]

Bases: CustomAttribute

EpicAttribute model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.EpicAttributes(requester)[source]

Bases: CustomAttributes

EpicAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:

project – Project id
name – name of the custom attribute
attrs – optional attributes of the custom attributes

instance: alias of EpicAttribute

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.EpicStatus(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Taiga Epic Status model

Parameters:

color – the color of EpicStatus
is_closed – closed property of EpicStatus
name – The name of EpicStatus
order – order of EpicStatus
project – the Taiga project of EpicStatus
slug – the slug of EpicStatus

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.EpicStatuses(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

create(project, name, **attrs)[source]

Create a new EpicStatus.

Parameters:

project – Project id
name – name of EpicStatus
attrs – optional attributes of EpicStatus

instance: alias of EpicStatus

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Epics(requester)[source]

Bases: ListResource

Epics factory class

create(project, subject, **attrs)[source]

Create a new Epic.

Parameters:

project – Project id
subject – subject of Epic
attrs – optional attributes of Epic

instance: alias of Epic

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.History(*args, **kwargs)[source]

Bases: InstanceResource

History model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.HistoryEntity(requester)[source]

Bases: object

HistoryEntity model

delete_comment(resource_id, comment_id)[source]

Delete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to delete

get(resource_id)[source]

Get a history element

Parameters:: resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)

undelete_comment(resource_id, comment_id)[source]

Undelete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to undelete

class taiga.models.models.HistoryEpic(*args, **kwargs)[source]

Bases: HistoryEntity

HistoryEpic model

delete_comment(resource_id, comment_id)

Delete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to delete

get(resource_id)

Get a history element

Parameters:: resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)

undelete_comment(resource_id, comment_id)

Undelete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to undelete

class taiga.models.models.HistoryIssue(*args, **kwargs)[source]

Bases: HistoryEntity

HistoryIssue model

delete_comment(resource_id, comment_id)

Delete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to delete

get(resource_id)

Get a history element

Parameters:: resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)

undelete_comment(resource_id, comment_id)

Undelete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to undelete

class taiga.models.models.HistoryTask(*args, **kwargs)[source]

Bases: HistoryEntity

HistoryTask model

delete_comment(resource_id, comment_id)

Delete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to delete

get(resource_id)

Get a history element

Parameters:: resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)

undelete_comment(resource_id, comment_id)

Undelete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to undelete

class taiga.models.models.HistoryUserStory(*args, **kwargs)[source]

Bases: HistoryEntity

HistoryUserStory model

delete_comment(resource_id, comment_id)

Delete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to delete

get(resource_id)

Get a history element

Parameters:: resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)

undelete_comment(resource_id, comment_id)

Undelete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to undelete

class taiga.models.models.HistoryWiki(*args, **kwargs)[source]

Bases: HistoryEntity

HistoryWiki model

delete_comment(resource_id, comment_id)

Delete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to delete

get(resource_id)

Get a history element

Parameters:: resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)

undelete_comment(resource_id, comment_id)

Undelete a comment

Parameters:

resource_id – id of the resource object (resource type is defined by the HistoryEntity subclass used)
comment_id – id of the comment to undelete

class taiga.models.models.Issue(requester, **params)[source]

Bases: CustomAttributeResource, CommentableResource

Issue model

Parameters:

requester – Requester instance
assigned_to – User id this issue is assigned to
description – description of the issue (not available in the Issues.list() response)
is_blocked – set if this issue is blocked or not
milestone – Milestone id
project – Project id
status – Status id
severity – class:Severity id
priority – class:Priority id
type – class:Type id
subject – subject of the issue
tags – array of tags
watchers – array of watchers id
due_date – Issue due date

add_comment(comment)

Add a comment to the current element

Parameters:: comment – the comment you want to insert

attach(attached_file, **attrs)[source]

Attach a file to the Issue

Parameters:

attached_file – file path to attach
attrs – optional attributes for the attached file

delete(query=None): Delete the current InstanceResource

downvote()[source]: Downvote Issue.

get_attributes(): Get all the attributes of the current object

list_attachments()[source]: Get a list of IssueAttachment.

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

set_attribute(id, value, version=1)

Set attribute to a specific value

Parameters:

id – id of the attribute
value – value of the attribute
version – version of the attribute (default = 1)

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

upvote()[source]: Upvote Issue.

class taiga.models.models.IssueAttachment(requester, **params)[source]

Bases: Attachment

IssueAttachment model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.IssueAttachments(requester)[source]

Bases: Attachments

IssueAttachments factory

create(project, object_id, attached_file, **attrs)

Create a new Attachment.

Parameters:

project – Project id
object_id – id of the current object
ref – Task reference
attached_file – file path that you want to upload
attrs – optional attributes for the Attachment

instance: alias of IssueAttachment

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.IssueAttribute(requester, **params)[source]

Bases: CustomAttribute

IssueAttribute model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.IssueAttributes(requester)[source]

Bases: CustomAttributes

IssueAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:

project – Project id
name – name of the custom attribute
attrs – optional attributes of the custom attributes

instance: alias of IssueAttribute

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.IssueStatus(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Issue Status model

Parameters:

name – name of IssueStatus
color – color of IssueStatus
order – order of IssueStatus
project – the taiga project of IssueStatus
is_closed – is closed property of IssueStatus

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.IssueStatuses(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

IssueStatuses factory

instance: alias of IssueStatus

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.IssueType(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

IssueType model

Parameters:

name – name of IssueType
color – color of IssueType
order – order of IssueType
project – the taiga project of IssueType

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.IssueTypes(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

IssueTypes factory

instance: alias of IssueType

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Issues(requester)[source]

Bases: ListResource

create(project, subject, priority, status, issue_type, severity, **attrs)[source]

Create a new Task.

Parameters:

project – Project id
subject – subject of Issue
priority – priority of Issue
status – status of Issue
issue_type – Issue type of Issue
severity – severity of Issue
attrs – optional attributes of Task

instance: alias of Issue

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Membership(requester, **params)[source]

Bases: InstanceResource

Membership model

Parameters:

email – email of Membership
role – role of Membership
project – project of Membership

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Memberships(requester)[source]

Bases: ListResource

Memberships factory class

create(project, email, role, **attrs)[source]

Create a new Membership.

Parameters:

project – Project id
email – email of Membership
role – role of Membership
attrs – optional attributes of Membership

instance: alias of Membership

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Milestone(requester, **params)[source]

Bases: InstanceResource

Milestone model

Parameters:

name – the name of Milestone
project – the Taiga project of Milestone
estimated_start – the estimated start of Milestone
estimated_finish – the estimated finish of Milestone
disponibility – the disponibility of Milestone

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

stats()[source]: Get the stats for the current Milestone

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Milestones(requester)[source]

Bases: ListResource

Milestones factory

create(project, name, estimated_start, estimated_finish, **attrs)[source]

Create a new Milestone.

Parameters:

project – Project id
name – name of Milestone
estimated_start – est. start time of Milestone
estimated_finish – est. finish time of Milestone
attrs – optional attributes of Milestone

instance: alias of Milestone

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.MoveOnDestroyMixinList[source]

Bases: object

Mixin that define a delete method with moveTo parameter

class taiga.models.models.MoveOnDestroyMixinObject[source]

Bases: object

Mixin that define a delete method with moveTo parameter

class taiga.models.models.Point(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Taiga Point model

Parameters:

color – the color of Point
value – value of Point
name – name of Point
order – the order of Point
project – the Taiga project of Point

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Points(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

Points factory

create(project, name, value, **attrs)[source]

Create a new UserStoryStatus.

Parameters:

project – Project id
name – name of Point
value – value of Point
attrs – optional attributes of Point

instance: alias of Point

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Priorities(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

Priorities factory class

create(project, name, **attrs)[source]

Create a new Priority.

Parameters:

project – Project id
name – email of the priority
attrs – optional attributes of the priority

instance: alias of Priority

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Priority(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Priority model

Parameters:

name – name of Priority
color – color of the class:Priority
order – order of the class:Priority
project – project of the class:Priority

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Project(requester, **params)[source]

Bases: InstanceResource

Taiga project model

Parameters:

requester – Requester instance
name – name of the project
description – description of the project (not available in the Projects.list() response)
creation_template – base template for the project
is_backlog_activated – name of the project
is_issues_activated – name of the project
is_kanban_activated – name of the project
is_wiki_activated – determines if the project is private or not
is_private – determines if the project is private or not
videoconferences – appear-in or talky
videoconferences_salt – for videoconference chat url generation
total_milestones – missing
total_story_points – missing

add_epic(subject, **attrs)[source]

Adds a UserStory and returns a UserStory resource.

Parameters:

subject – subject of UserStory
attrs – other UserStory attributes

add_issue(subject, priority, status, issue_type, severity, **attrs)[source]

Adds a Issue and returns a Issue resource.

Parameters:

subject – subject of Issue
priority – priority of Issue
priority – status of Issue
issue_type – type of Issue
severity – severity of Issue
attrs – other Issue attributes

add_issue_attribute(name, **attrs)[source]

Add a new Issue attribute and return a IssueAttribute object.

Parameters:

name – name of IssueAttribute
attrs – optional attributes for IssueAttribute

add_issue_status(name, **attrs)[source]

Add a Issue status to the project and returns a IssueStatus object.

Parameters:

name – name of IssueStatus
attrs – optional attributes for IssueStatus

add_issue_type(name, **attrs)[source]

Add a Issue type to the project and returns a IssueType object.

Parameters:

name – name of IssueType
attrs – optional attributes for IssueType

add_membership(email, role, **attrs)[source]

Add a Membership to the project and returns a Membership resource.

Parameters:

email – email for Membership
role – role for Membership
attrs – role for Membership
attrs – optional Membership attributes

add_milestone(name, estimated_start, estimated_finish, **attrs)[source]

Add a Milestone to the project and returns a Milestone object.

Parameters:

name – name of Milestone
estimated_start – estimated start time of the Milestone
estimated_finish – estimated finish time of the Milestone
attrs – optional attributes for Milestone

add_point(name, value, **attrs)[source]

Add a Point to the project and returns a Point object.

Parameters:

name – name of Point
value – value of Point
attrs – optional attributes for Point

add_priority(name, **attrs)[source]

Add a Priority to the project and returns a Priority object.

Parameters:

name – name of Priority
attrs – optional attributes for Priority

add_role(name, **attrs)[source]

Add a Role to the project and returns a Role object.

Parameters:

name – name of Role
attrs – optional attributes for Role

add_severity(name, **attrs)[source]

Add a Severity to the project and returns a Severity object.

Parameters:

name – name of Severity
attrs – optional attributes for Severity

add_swimlane(name, **attrs)[source]

Adds a SwimLane and returns a SwimLane resource.

Parameters:

name – name of SwimLane
attrs – other SwimLane attributes

add_tag(tag, color=None)[source]

Add a new tag and return a response object.

Parameters:

tag – name of the tag
color – optional color of the tag

add_task_attribute(name, **attrs)[source]

Add a new Task attribute and return a TaskAttribute object.

Parameters:

name – name of TaskAttribute
attrs – optional attributes for TaskAttribute

add_task_status(name, **attrs)[source]

Add a Task status to the project and returns a TaskStatus object.

Parameters:

name – name of TaskStatus
attrs – optional attributes for TaskStatus

add_user_story(subject, **attrs)[source]

Adds a UserStory and returns a UserStory resource.

Parameters:

subject – subject of UserStory
attrs – other UserStory attributes

add_user_story_attribute(name, **attrs)[source]

Add a new User Story attribute and return a UserStoryAttribute object.

Parameters:

name – name of UserStoryAttribute
attrs – optional attributes for UserStoryAttribute

add_user_story_status(name, **attrs)[source]

Add a UserStory status to the project and returns a UserStoryStatus object.

Parameters:

name – name of UserStoryStatus
attrs – optional attributes for UserStoryStatus

add_webhook(name, url, key, **attrs)[source]

Add a new Webhook and return a Webhook object.

Parameters:

name – name of Webhook
url – payload url of Webhook
key – secret key of Webhook
attrs – optional attributes for Webhook

add_wikilink(title, href, **attrs)[source]

Add a Wiki link to the project and returns a WikiLink object.

Parameters:

title – title of WikiLink
href – href of WikiLink
attrs – optional attributes for WikiLink

add_wikipage(slug, content, **attrs)[source]

Add a Wiki page to the project and returns a WikiPage object.

Parameters:

name – name of WikiPage
attrs – optional attributes for WikiPage

delete(query=None): Delete the current InstanceResource

duplicate(name, description, is_private=False, users=[], **attrs)[source]

Duplicate a Project

Parameters:

name – name of new Project
description – description of new Project
is_private – determines if the project is private or not
users – users of the new Project
attrs – optional attributes for the new Project

get_epic_by_ref(ref)[source]

Get a Epic by ref.

Parameters:: ref – Epic reference

get_issue_by_ref(ref)[source]

Get a Issue by ref.

Parameters:: ref – Issue reference

get_task_by_ref(ref)[source]

Get a Task by ref.

Parameters:: ref – Task reference

get_userstory_by_ref(ref)[source]

Get a UserStory by ref.

Parameters:: ref – UserStory reference

import_issue(subject, priority, status, issue_type, severity, **attrs)[source]

Import and issue and returns a Issue resource.

Parameters:

subject – subject of Issue
priority – priority of Issue
status – status of Issue
issue_type – issue type of Issue
severity – severity of Issue
attrs – optional Issue attributes

import_milestone(name, estimated_start, estimated_finish, **attrs)[source]

Import a Milestone and returns a Milestone object.

Parameters:

name – name of Milestone
estimated_start – estimated start time of the Milestone
estimated_finish – estimated finish time of the Milestone
attrs – optional attributes for Milestone

import_task(subject, status, **attrs)[source]

Import a Task and return a Task object.

Parameters:

subject – subject of Task
status – status of Task
attrs – optional attributes for Task

import_user_story(subject, status, **attrs)[source]

Import an user story and returns a UserStory resource.

Parameters:

subject – subject of UserStory
status – status of UserStory
attrs – optional UserStory attributes

import_wikilink(title, href, **attrs)[source]

Import a Wiki link and return a WikiLink object.

Parameters:

title – title of WikiLink
href – href of WikiLink
attrs – optional attributes for WikiLink

import_wikipage(slug, content, **attrs)[source]

Import a Wiki page and return a WikiPage object.

Parameters:

slug – slug of WikiPage
content – content of WikiPage
attrs – optional attributes for Task

issues_stats()[source]: Get stats for issues of the project

like()[source]: Like the project

list_epic_attributes()[source]: Get the list of EpicAttribute resources for the project.

list_epics()[source]: Get the list of Epic resources for the project.

list_issue_attributes()[source]: Get the list of IssueAttribute resources for the project.

list_issue_statuses()[source]: Get the list of IssueStatus resources for the project.

list_issue_types()[source]: Get the list of IssueType resources for the project.

list_issues()[source]: Returns the Issue list of the project.

list_memberships()[source]: Get the list of Membership resources for the project.

list_milestones(**queryparams)[source]: Get the list of Milestone resources for the project.

list_points()[source]: Get the list of Point resources for the project.

list_priorities()[source]: Get the list of Priority resources for the project.

list_roles()[source]: Get the list of Role resources for the project.

list_severities()[source]: Get the list of Severity resources for the project.

list_swimlanes(**queryparams)[source]: Returns the SwimLane list of the project.

list_tags()[source]: Get the list of tags for the project.

list_task_attributes()[source]: Get the list of TaskAttribute resources for the project.

list_task_statuses()[source]: Get the list of Task resources for the project.

list_user_stories(**queryparams)[source]: Returns the UserStory list of the project.

list_user_story_attributes()[source]: Get the list of UserStoryAttribute resources for the project.

list_user_story_statuses()[source]: Get the list of UserStoryStatus resources for the project.

list_webhooks()[source]: Get the list of Webhook resources for the project.

list_wikilinks()[source]: Get the list of WikiLink resources for the project.

list_wikipages()[source]: Get the list of WikiPage resources for the project.

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

star()[source]: Stars the project

Deprecated since version 0.8.5: Update Taiga and use like instead

stats()[source]: Get the stats of the project

to_dict(): Get a dictionary representation of InstanceResource

unlike()[source]: Unlike the project

unstar()[source]: Unstars the project

Deprecated since version 0.8.5: Update Taiga and use unlike instead

update(**args): Update the current InstanceResource

class taiga.models.models.Projects(requester)[source]

Bases: ListResource

Projects factory

create(name, description, **attrs)[source]

Create a new Project

Parameters:

name – name of Project
description – description of Project
attrs – optional attributes for Project

get_by_slug(slug)[source]

Get a Project by slug

Parameters:: slug – the slug of Project

instance: alias of Project

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Role(requester, **params)[source]

Bases: InstanceResource

Role model

Parameters:

requester – Requester instance
name – name of Role
slug – slug of Role
order – order of Role
computable – choose if Role is computable or not

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Roles(requester)[source]

Bases: ListResource

Roles factory

create(project, name, **attrs)[source]

Create a new Role

Parameters:

project – Project id
name – name of Role
attrs – optional attributes for Role

instance: alias of Role

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Severities(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

Severities factory

create(project, name, **attrs)[source]

Create a new Severity

Parameters:

project – Project id
name – name of Severity
attrs – optional attributes for Role

instance: alias of Severity

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Severity(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Severity model

Parameters:

requester – Requester instance
name – name of Severity
order – order of Severity
project – Project id

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.SwimLane(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Taiga Swimlane model

Parameters:

name – The name of SwimLane
order – the order of SwimLane
project – the project of SwimLane
statuses – the statuses of SwimLane

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.SwimLanes(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

create(project, name, **attrs)[source]

Create a new SwimLane.

Parameters:

project – Project id
name – name of SwimLane
attrs – optional attributes of SwimLane

instance: alias of SwimLane

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Task(requester, **params)[source]

Bases: CustomAttributeResource, CommentableResource

Task model

Parameters:

assigned_to – assigned to property of TaskStatus
blocked_note – blocked note of TaskStatus
description – description of of TaskStatus (not available in the Tasks.list() response)
version – version of TaskStatus
is_blocked – is blocked property of TaskStatus
milestone – milestone property of TaskStatus
project – the project of TaskStatus
user_story – the user story of TaskStatus
status – status of TaskStatus
subject – subject of TaskStatus
tags – tags of TaskStatus
us_order – the use order of TaskStatus
taskboard_order – the taskboard order of TaskStatus
is_iocaine – the is iocaine of TaskStatus
external_reference – external reference of TaskStatus
watchers – watchers of TaskStatus
due_date – Task due date

add_comment(comment)

Add a comment to the current element

Parameters:: comment – the comment you want to insert

attach(attached_file, **attrs)[source]

Attach a file to the Task

Parameters:

attached_file – file path to attach
attrs – optional attributes for the attached file

delete(query=None): Delete the current InstanceResource

get_attributes(): Get all the attributes of the current object

list_attachments()[source]: Get a list of TaskAttachment.

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

set_attribute(id, value, version=1)

Set attribute to a specific value

Parameters:

id – id of the attribute
value – value of the attribute
version – version of the attribute (default = 1)

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.TaskAttachment(requester, **params)[source]

Bases: Attachment

TaskAttachment model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.TaskAttachments(requester)[source]

Bases: Attachments

TaskAttachments factory

create(project, object_id, attached_file, **attrs)

Create a new Attachment.

Parameters:

project – Project id
object_id – id of the current object
ref – Task reference
attached_file – file path that you want to upload
attrs – optional attributes for the Attachment

instance: alias of TaskAttachment

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.TaskAttribute(requester, **params)[source]

Bases: CustomAttribute

TaskAttribute model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.TaskAttributes(requester)[source]

Bases: CustomAttributes

TaskAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:

project – Project id
name – name of the custom attribute
attrs – optional attributes of the custom attributes

instance: alias of TaskAttribute

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.TaskStatus(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Task Status model

Parameters:

name – the name of TaskStatus
color – the color of TaskStatus
order – the order of TaskStatus
project – the project of TaskStatus
is_closed – the is closed property of TaskStatus

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.TaskStatuses(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

create(project, name, **attrs)[source]

Create a new TaskStatus.

Parameters:

project – Project id
name – name of TaskStatus
attrs – optional attributes of TaskStatus

instance: alias of TaskStatus

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Tasks(requester)[source]

Bases: ListResource

Tasks factory

create(project, subject, status, **attrs)[source]

Create a new Task.

Parameters:

project – Project id
subject – subject of Task
status – status of Task
attrs – optional attributes of Task

instance: alias of Task

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.User(requester, **params)[source]

Bases: InstanceResource

User model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

starred_projects()[source]: Get a list of starred Project.

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.UserStories(requester)[source]

Bases: ListResource

UserStories factory class

create(project, subject, **attrs)[source]

Create a new UserStory.

Parameters:

project – Project id
subject – subject of UserStory
attrs – optional attributes of UserStory

instance: alias of UserStory

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.UserStory(requester, **params)[source]

Bases: CustomAttributeResource, CommentableResource

User Story model

Parameters:

assigned_to – assigned to of UserStory
assigned_users – additional users assigned to of UserStory
backlog_order – backlog order of UserStory
blocked_note – blocked note of UserStory
version – version of UserStory
client_requirement – client requirement of UserStory
description – description of UserStory (not available in the UserStories.list() response)
is_blocked – is blocked of UserStory
kanban_order – kanban order of UserStory
milestone – milestone of UserStory
points – points of UserStory
project – project of UserStory
sprint_order – sprint order of UserStory
status – status of UserStory
subject – subject of UserStory
tags – tags of UserStory
team_requirement – team requirement of UserStory
watchers – watchers of UserStory
due_date – UserStory due date
generated_from_issue – UserStory parent issue
generated_from_task – UserStory parent task

add_comment(comment)

Add a comment to the current element

Parameters:: comment – the comment you want to insert

add_task(subject, status, **attrs)[source]: Add a Task to the current UserStory and return it. :param subject: subject of Task :param status: status of Task :param attrs: optional attributes for Task

attach(attached_file, **attrs)[source]

Attach a file to the UserStory

Parameters:

attached_file – file path to attach
attrs – optional attributes for the attached file

delete(query=None): Delete the current InstanceResource

get_attributes(): Get all the attributes of the current object

list_attachments()[source]: Get a list of UserStoryAttachment.

list_tasks()[source]: Get a list of Task in the current UserStory.

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

set_attribute(id, value, version=1)

Set attribute to a specific value

Parameters:

id – id of the attribute
value – value of the attribute
version – version of the attribute (default = 1)

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.UserStoryAttachment(requester, **params)[source]

Bases: Attachment

UserStoryAttachment class

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.UserStoryAttachments(requester)[source]

Bases: Attachments

UserStoryAttachments factory class

create(project, object_id, attached_file, **attrs)

Create a new Attachment.

Parameters:

project – Project id
object_id – id of the current object
ref – Task reference
attached_file – file path that you want to upload
attrs – optional attributes for the Attachment

instance: alias of UserStoryAttachment

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.UserStoryAttribute(requester, **params)[source]

Bases: CustomAttribute

UserStoryAttribute model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.UserStoryAttributes(requester)[source]

Bases: CustomAttributes

UserStoryAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:

project – Project id
name – name of the custom attribute
attrs – optional attributes of the custom attributes

instance: alias of UserStoryAttribute

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.UserStoryStatus(requester, **params)[source]

Bases: MoveOnDestroyMixinObject, InstanceResource

Taiga User Story Status model

Parameters:

color – the color of UserStoryStatus
is_closed – closed property of UserStoryStatus
name – The name of UserStoryStatus
order – order of UserStoryStatus
project – the Taiga project of UserStoryStatus
wip_limit – wip limit of UserStoryStatus

delete(move_to_id): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.UserStoryStatuses(requester)[source]

Bases: MoveOnDestroyMixinList, ListResource

create(project, name, **attrs)[source]

Create a new UserStoryStatus.

Parameters:

project – Project id
name – name of UserStoryStatus
attrs – optional attributes of UserStoryStatus

instance: alias of UserStoryStatus

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Users(requester)[source]

Bases: ListResource

Users factory class

instance: alias of User

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.Webhook(requester, **params)[source]

Bases: InstanceResource

Webhook model

Parameters:

requester – Requester instance
name – name of Webhook
url – payload url of Webhook
key – secret key of Webhook

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.Webhooks(requester)[source]

Bases: ListResource

Webhooks factory

create(project, name, url, key, **attrs)[source]

Create a new Webhook

Parameters:

project – Project id
name – name of Webhook
url – payload url of Webhook
key – secret key of Webhook
attrs – optional attributes for Webhook

instance: alias of Webhook

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.WikiAttachment(requester, **params)[source]

Bases: Attachment

WikiAttachment model

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.WikiAttachments(requester)[source]

Bases: Attachments

WikiAttachments factory

create(project, object_id, attached_file, **attrs)

Create a new Attachment.

Parameters:

project – Project id
object_id – id of the current object
ref – Task reference
attached_file – file path that you want to upload
attrs – optional attributes for the Attachment

instance: alias of WikiAttachment

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.WikiLink(requester, **params)[source]

Bases: InstanceResource

WikiLink model

Parameters:

project – Project id
title – title of the wiki link
href – href for the wiki link
order – order of the wiki link

delete(query=None): Delete the current InstanceResource

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.WikiLinks(requester)[source]

Bases: ListResource

WikiLinks factory

create(project, title, href, **attrs)[source]

Create a new WikiLink

Parameters:

project – Project id
title – title of the wiki link
href – href for the wiki link
attrs – optional attributes for the WikiLink

instance: alias of WikiLink

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.models.WikiPage(requester, **params)[source]

Bases: InstanceResource

WikiPage model

Parameters:

project – Project id
slug – slug of the wiki page
content – content of the wiki page
watchers – list of watchers id

attach(attached_file, **attrs)[source]

Attach a file to the WikiPage

Parameters:

attached_file – file path to attach
attrs – optional attributes for the attached file

delete(query=None): Delete the current InstanceResource

list_attachments()[source]: Get a list of WikiAttachment.

classmethod parse(requester, entry): Turns a JSON object into a model instance.

patch(fields, **args): Patch the current InstanceResource

to_dict(): Get a dictionary representation of InstanceResource

update(**args): Update the current InstanceResource

class taiga.models.models.WikiPages(requester)[source]

Bases: ListResource

WikiPages factory

create(project, slug, content, **attrs)[source]

create a new WikiPage

Parameters:

project – Project id
slug – slug of the wiki page
content – content of the wiki page
attrs – optional attributes for the WikiPage

instance: alias of WikiPage

list(pagination=True, page_size=None, page=None, **queryparams)

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries): Parse a JSON array into a list of model instances.

parse_list(entries): Parse a JSON array into a list of model instances.

class taiga.models.base.InstanceResource(requester, **params)[source]

InstanceResource model

Base class for methods that operates on a single resource (update(), patch(), delete()).

Parameters:

requester – Requester instance
params – :various parameters

delete(query=None)[source]: Delete the current InstanceResource

classmethod parse(requester, entry)[source]: Turns a JSON object into a model instance.

patch(fields, **args)[source]: Patch the current InstanceResource

to_dict()[source]: Get a dictionary representation of InstanceResource

update(**args)[source]: Update the current InstanceResource

class taiga.models.base.ListResource(requester)[source]

ListResource model

Base class for methods that operates on a list of resources (list(), get(), delete()).

Parameters:: requester – Requester instance

list(pagination=True, page_size=None, page=None, **queryparams)[source]

Retrieves a list of objects.

By default uses local cache and remote pagination

If pagination is used and no page is requested (the default), all the remote objects are retrieved and appended in a single list.

If pagination is disabled, all the objects are fetched from the endpoint and returned. This may trigger some parsing error if the result set is very large.

Parameters:

pagination – Use pagination (default: True)
page_size – Size of the pagination page (default: 100). Any non numeric value will be casted to the default value
page – Page number to retrieve (default: None). Ignored if pagination is False
queryparams – Additional filter parameters as accepted by the remote API

Returns:

classmethod parse(requester, entries)[source]: Parse a JSON array into a list of model instances.

parse_list(entries)[source]: Parse a JSON array into a list of model instances.

class taiga.models.base.SearchableList(iterable=(), /)[source]