Welcome to python-taiga’s documentation!

A module for using the Taiga REST API.

Install

pip install python-taiga

Getting Started

Getting started with the Taiga API couldn’t be easier. Create a TaigaAPI and you’re ready to go.

API Credentials

The TaigaAPI needs your Taiga credentials. You can pass these directly to the auth method (see the code below).

from taiga import TaigaAPI

api = TaigaAPI()

api.auth(
    username='user',
    password='psw'
)

Alternately, you can pass a token to the constructor TaigaAPI constructor.

from taiga import TaigaAPI

api = TaigaAPI(token='mytoken')

You can also specify a different host if you use Taiga somewhere else

from taiga import TaigaAPI

api = TaigaAPI(
    host='http://taiga.my.host.org'
)

To use LDAP or other authentication backends, user auth_type argumento

from taiga import TaigaAPI

api = TaigaAPI(
    host='http://taiga.my.host.org',
    auth_type='ldap'
)

To ignore SSL certificate verification (use at your own risk!) use tls_verify argument

from taiga import TaigaAPI

api = TaigaAPI(
    host='http://taiga.my.host.org',
    tls_verify=False
)

Get projects, user stories, task and issues

You can get projects, user stories, tasks and issues using the primary key or using slug/ref

new_project = api.projects.get_by_slug('nephila')
print (new_project.get_issue_by_ref(1036))
print (new_project.get_userstory_by_ref(1111))
print (new_project.get_task_by_ref(1112))

Create a project

new_project = api.projects.create('TEST PROJECT', 'TESTING API')

Create a new user story

userstory = new_project.add_user_story(
    'New Story', description='Blablablabla'
)

You can also create a milestone and pass it to a story

jan_feb_milestone = new_project.add_milestone(
    'MILESTONE 1', '2015-01-26', '2015-02-26'
)

userstory = new_project.add_user_story(
    'New Story', description='Blablablabla',
    milestone=jan_feb_milestone.id
)

To add a task to your user story just run

userstory.add_task(
    'New Task 2',
    new_project.task_statuses[0].id
)

Create an issue

newissue = new_project.add_issue(
    'New Issue',
    new_project.priorities.get(name='High').id,
    new_project.issue_statuses.get(name='New').id,
    new_project.issue_types.get(name='Bug').id,
    new_project.severities.get(name='Minor').id,
    description='Bug #5'
)

Create a custom attribute

new_project.add_issue_attribute(
    'Device', description='(iPad, iPod, iPhone, Desktop, etc.)'
)
newissue.set_attribute('1', 'Desktop')

List elements

projects = api.projects.list()
stories = api.user_stories.list()

You can also specify filters

tasks = api.tasks.list(project=1)

By default list returns all objects, eventually getting the paginated results behind the scenes.

Examples

No pagination

tasks = api.tasks.list(paginate=False)

Warning

be aware that the unpaginated results may exceed the data the parser can handle and may result in an error.

Retrieve a single page

tasks_page_1 = api.tasks.list(page=1)  # Will only return page 1

Specify the page size

tasks_page_1 = api.tasks.list(page=1, page_size=200)  # Will 200 results from page 1

Attach a file

You can attach files to issues, user stories and tasks

newissue.attach('README.md', description='Read the README in Issue')

Play with instances

Instances can have actions, for example you can star a project just calling

new_project = api.projects.create('TEST PROJECT', 'TESTING API')
new_project.star()

Any instance can be updated and deleted

new_project.name = 'New name for my project'
new_project.update()
new_project.delete()

History

You can access the history of issues, tasks, userstories and wiki pages:

history = api.history.user_story.get(user_story.id)

TaigaAPI documentation

Contents:

class taiga.client.TaigaAPI(host='https://api.taiga.io', token=None, token_type='Bearer', tls_verify=True, auth_type='normal')

Bases: object

TaigaAPI class

Parameters:
  • host – the host of your Taiga.io instance
  • token – the token you may provide
  • token_type – the token type
  • tls_verify – verify server certificate
  • auth_type – authentication type identifier
auth(username, password)

Authenticate you

Parameters:
  • username – your username
  • password – your password
auth_app(app_id, app_secret, auth_code, state='')

Authenticate an app

Parameters:
  • app_id – the app id
  • app_secret – the app secret
  • auth_code – the app auth code
me()

Get a taiga.models.models.User representing me

search(project, text='')

Search in your Taiga.io instance

Parameters:
  • project – the project id
  • text – the query of your search

Models documentation

Contents:

class taiga.models.models.Attachment(requester, **params)

Bases: taiga.models.base.InstanceResource

Attachment base class

Parameters:
delete()

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)

Bases: taiga.models.base.ListResource

Attachments factory base class

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

Create a new Attachment.

Parameters:
  • projectProject id
  • object_id – id of the current object
  • refTask 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

CommentableResource base class

add_comment(comment)

Add a comment to the current element

Parameters:comment – the comment you want to insert
delete()

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)

Bases: taiga.models.base.InstanceResource

CustomAttribute base class

Parameters:
  • requesterRequester instance
  • name – name of the custom attribute
  • description – id of the current object
  • order – order of the custom attribute
  • projectProject id
delete()

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)

Bases: taiga.models.base.InstanceResource

CustomAttributeResource base class

delete()

Delete the current InstanceResource

get_attributes()

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)

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)

Bases: taiga.models.base.ListResource

CustomAttributes factory base class

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:
  • projectProject 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:

<SearchableList>

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)

Bases: taiga.models.models.CustomAttributeResource, taiga.models.models.CommentableResource

Epic model

Parameters:
  • assigned_to – assigned to property of the Epic
  • blocked_note – blocked note of the Epic
  • description – description of of the Epic
  • is_blocked – is blocked property of the Epic
  • is_closed – is closed property of the Epic
  • color – the color of the Epic
  • project – the project of the TaskStatus
  • subject – subject of the TaskStatus
  • tags – tags of the TaskStatus
  • watchers – watchers of the TaskStatus
  • version – version of the Epic
add_comment(comment)

Add a comment to the current element

Parameters:comment – the comment you want to insert
attach(attached_file, **attrs)

Attach a file to the Epic

Parameters:
  • attached_file – file path to attach
  • attrs – optional attributes for the attached file
delete()

Delete the current InstanceResource

get_attributes()

Get all the attributes of the current object

list_attachments()

Get a list of EpicAttachment.

list_user_stories(**queryparams)

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)

Bases: taiga.models.models.Attachment

EpicAttachment class

delete()

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)

Bases: taiga.models.models.Attachments

EpicAttachments factory class

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

Create a new Attachment.

Parameters:
  • projectProject id
  • object_id – id of the current object
  • refTask 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Taiga Epic Status model

Parameters:
delete()

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.Epics(requester)

Bases: taiga.models.base.ListResource

Epics factory class

create(project, subject, **attrs)

Create a new Epic.

Parameters:
  • projectProject id
  • subject – subject of the Epic
  • attrs – optional attributes of the 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

History model

delete()

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)

Bases: object

HistoryEntity model

delete_comment(resource_id, ent_id)

Delete a comment

Parameters:
  • resource_id

  • ent_id

get(resource_id)

Get a history element

Parameters:resource_id

undelete_comment(resource_id, ent_id)

Undelete a comment

Parameters:
  • resource_id

  • ent_id

class taiga.models.models.HistoryEpic(*args, **kwargs)

Bases: taiga.models.models.HistoryEntity

HistoryEpic model

delete_comment(resource_id, ent_id)

Delete a comment

Parameters:
  • resource_id

  • ent_id

get(resource_id)

Get a history element

Parameters:resource_id

undelete_comment(resource_id, ent_id)

Undelete a comment

Parameters:
  • resource_id

  • ent_id

class taiga.models.models.HistoryIssue(*args, **kwargs)

Bases: taiga.models.models.HistoryEntity

HistoryIssue model

delete_comment(resource_id, ent_id)

Delete a comment

Parameters:
  • resource_id

  • ent_id

get(resource_id)

Get a history element

Parameters:resource_id

undelete_comment(resource_id, ent_id)

Undelete a comment

Parameters:
  • resource_id

  • ent_id

class taiga.models.models.HistoryTask(*args, **kwargs)

Bases: taiga.models.models.HistoryEntity

HistoryTask model

delete_comment(resource_id, ent_id)

Delete a comment

Parameters:
  • resource_id

  • ent_id

get(resource_id)

Get a history element

Parameters:resource_id

undelete_comment(resource_id, ent_id)

Undelete a comment

Parameters:
  • resource_id

  • ent_id

class taiga.models.models.HistoryUserStory(*args, **kwargs)

Bases: taiga.models.models.HistoryEntity

HistoryUserStory model

delete_comment(resource_id, ent_id)

Delete a comment

Parameters:
  • resource_id

  • ent_id

get(resource_id)

Get a history element

Parameters:resource_id

undelete_comment(resource_id, ent_id)

Undelete a comment

Parameters:
  • resource_id

  • ent_id

class taiga.models.models.HistoryWiki(*args, **kwargs)

Bases: taiga.models.models.HistoryEntity

HistoryWiki model

delete_comment(resource_id, ent_id)

Delete a comment

Parameters:
  • resource_id

  • ent_id

get(resource_id)

Get a history element

Parameters:resource_id

undelete_comment(resource_id, ent_id)

Undelete a comment

Parameters:
  • resource_id

  • ent_id

class taiga.models.models.Issue(requester, **params)

Bases: taiga.models.models.CustomAttributeResource, taiga.models.models.CommentableResource

Issue model

Parameters:
  • requesterRequester instance
  • assigned_toUser id this issue is assigned to
  • description – description of the issue
  • is_blocked – set if this issue is blocked or not
  • milestoneMilestone id
  • projectProject id
  • statusStatus 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_dateIssue due date
add_comment(comment)

Add a comment to the current element

Parameters:comment – the comment you want to insert
attach(attached_file, **attrs)

Attach a file to the Issue

Parameters:
  • attached_file – file path to attach
  • attrs – optional attributes for the attached file
delete()

Delete the current InstanceResource

downvote()

Downvote Issue.

get_attributes()

Get all the attributes of the current object

list_attachments()

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

Upvote Issue.

class taiga.models.models.IssueAttachment(requester, **params)

Bases: taiga.models.models.Attachment

IssueAttachment model

delete()

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)

Bases: taiga.models.models.Attachments

IssueAttachments factory

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

Create a new Attachment.

Parameters:
  • projectProject id
  • object_id – id of the current object
  • refTask 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:

<SearchableList>

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)

Bases: taiga.models.models.CustomAttribute

IssueAttribute model

delete()

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)

Bases: taiga.models.models.CustomAttributes

IssueAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:
  • projectProject 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Issue Status model

Parameters:
delete()

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)

Bases: taiga.models.base.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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

IssueType model

Parameters:
delete()

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)

Bases: taiga.models.base.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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Membership model

Parameters:
delete()

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)

Bases: taiga.models.base.ListResource

Memberships factory class

create(project, email, role, **attrs)

Create a new Membership.

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

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Milestone model

Parameters:
  • name – the name of the Milestone
  • project – the Taiga project of the Milestone
  • estimated_start – the estimated start of the Milestone
  • estimated_finish – the estimated finish of the Milestone
  • disponibility – the disponibility of the Milestone
delete()

Delete the current InstanceResource

classmethod parse(requester, entry)

Turns a JSON object into a model instance.

patch(fields, **args)

Patch the current InstanceResource

stats()

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)

Bases: taiga.models.base.ListResource

Milestones factory

create(project, name, estimated_start, estimated_finish, **attrs)

Create a new Milestone.

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

<SearchableList>

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.Point(requester, **params)

Bases: taiga.models.base.InstanceResource

Taiga Point model

Parameters:
  • color – the color of the Point
  • value – value of the Point
  • name – name of the Point
  • order – the order of the Point
  • project – the Taiga project of the Point
delete()

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)

Bases: taiga.models.base.ListResource

Points factory

create(project, name, value, **attrs)

Create a new UserStoryStatus.

Parameters:
  • projectProject id
  • name – name of the Point
  • value – value of the Point
  • attrs – optional attributes of the 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:

<SearchableList>

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)

Bases: taiga.models.base.ListResource

Priorities factory class

create(project, name, **attrs)

Create a new Priority.

Parameters:
  • projectProject 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Priority model

Parameters:
  • name – name of the Priority
  • color – color of the class:Priority
  • order – order of the class:Priority
  • project – project of the class:Priority
delete()

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)

Bases: taiga.models.base.InstanceResource

Taiga project model

Parameters:
  • requesterRequester instance
  • name – name of the project
  • description – description of the project
  • 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)

Adds a UserStory and returns a UserStory resource.

Parameters:
add_issue(subject, priority, status, issue_type, severity, **attrs)

Adds a Issue and returns a Issue resource.

Parameters:
  • subject – subject of the Issue
  • priority – priority of the Issue
  • priority – status of the Issue
  • issue_type – type of the Issue
  • severity – severity of the Issue
  • attrs – other Issue attributes
add_issue_attribute(name, **attrs)

Add a new Issue attribute and return a IssueAttribute object.

Parameters:
add_issue_status(name, **attrs)

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

Parameters:
add_issue_type(name, **attrs)

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

Parameters:
add_membership(email, role, **attrs)

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

Parameters:
add_milestone(name, estimated_start, estimated_finish, **attrs)

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

Parameters:
  • name – name of the 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)

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

Parameters:
  • name – name of the Point
  • value – value of the Point
  • attrs – optional attributes for Point
add_priority(name, **attrs)

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

Parameters:
add_role(name, **attrs)

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

Parameters:
  • name – name of the Role
  • attrs – optional attributes for Role
add_severity(name, **attrs)

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

Parameters:
add_tag(tag, color=None)

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)

Add a new Task attribute and return a TaskAttribute object.

Parameters:
add_task_status(name, **attrs)

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

Parameters:
add_user_story(subject, **attrs)

Adds a UserStory and returns a UserStory resource.

Parameters:
add_user_story_attribute(name, **attrs)

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

Parameters:
add_user_story_status(name, **attrs)

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

Parameters:
add_webhook(name, url, key, **attrs)

Add a new Webhook and return a Webhook object.

Parameters:
  • name – name of the Webhook
  • url – payload url of the Webhook
  • key – secret key of the Webhook
  • attrs – optional attributes for Webhook

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

Parameters:
add_wikipage(slug, content, **attrs)

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

Parameters:
delete()

Delete the current InstanceResource

get_epic_by_ref(ref)

Get a Epic by ref.

Parameters:refEpic reference
get_issue_by_ref(ref)

Get a Issue by ref.

Parameters:refIssue reference
get_task_by_ref(ref)

Get a Task by ref.

Parameters:refTask reference
get_userstory_by_ref(ref)

Get a UserStory by ref.

Parameters:refUserStory reference
import_issue(subject, priority, status, issue_type, severity, **attrs)

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)

Import a Milestone and returns a Milestone object.

Parameters:
  • name – name of the 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)

Import a Task and return a Task object.

Parameters:
  • subject – subject of the Task
  • status – status of the Task
  • attrs – optional attributes for Task
import_user_story(subject, status, **attrs)

Import an user story and returns a UserStory resource.

Parameters:

Import a Wiki link and return a WikiLink object.

Parameters:
import_wikipage(slug, content, **attrs)

Import a Wiki page and return a WikiPage object.

Parameters:
  • slug – slug of the WikiPage
  • content – content of the WikiPage
  • attrs – optional attributes for Task
issues_stats()

Get stats for issues of the project

like()

Like the project

list_epics()

Get the list of Epic resources for the project.

list_issue_attributes()

Get the list of IssueAttribute resources for the project.

list_issue_statuses()

Get the list of IssueStatus resources for the project.

list_issue_types()

Get the list of IssueType resources for the project.

list_issues()

Returns the Issue list of the project.

list_memberships()

Get the list of Membership resources for the project.

list_milestones(**queryparams)

Get the list of Milestone resources for the project.

list_points()

Get the list of Point resources for the project.

list_priorities()

Get the list of Priority resources for the project.

list_roles()

Get the list of Role resources for the project.

list_severities()

Get the list of Severity resources for the project.

list_tags()

Get the list of tags for the project.

list_task_attributes()

Get the list of TaskAttribute resources for the project.

list_task_statuses()

Get the list of Task resources for the project.

list_user_stories()

Returns the UserStory list of the project.

list_user_story_attributes()

Get the list of UserStoryAttribute resources for the project.

list_user_story_statuses()

Get the list of UserStoryStatus resources for the project.

list_webhooks()

Get the list of Webhook resources for the project.

Get the list of WikiLink resources for the project.

list_wikipages()

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

Stars the project

Deprecated since version 0.8.5: Update Taiga and use like instead

stats()

Get the stats of the project

to_dict()

Get a dictionary representation of InstanceResource

unlike()

Unlike the project

unstar()

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)

Bases: taiga.models.base.ListResource

Projects factory

create(name, description, **attrs)

Create a new Project

Parameters:
  • name – name of the Project
  • description – description of the Project
  • attrs – optional attributes for Project
get_by_slug(slug)

Get a Project by slug

Parameters:slug – the slug of the 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Role model

Parameters:
  • requesterRequester instance
  • name – name of the Role
  • slug – slug of the Role
  • order – order of the Role
  • computable – choose if Role is computable or not
delete()

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)

Bases: taiga.models.base.ListResource

Roles factory

create(project, name, **attrs)

Create a new Role

Parameters:
  • projectProject id
  • name – name of the 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:

<SearchableList>

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)

Bases: taiga.models.base.ListResource

Severities factory

create(project, name, **attrs)

Create a new Severity

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

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Severity model

Parameters:
  • requesterRequester instance
  • name – name of the Severity
  • order – order of the Severity
  • projectProject id
delete()

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.Task(requester, **params)

Bases: taiga.models.models.CustomAttributeResource, taiga.models.models.CommentableResource

Task model

Parameters:
add_comment(comment)

Add a comment to the current element

Parameters:comment – the comment you want to insert
attach(attached_file, **attrs)

Attach a file to the Task

Parameters:
  • attached_file – file path to attach
  • attrs – optional attributes for the attached file
delete()

Delete the current InstanceResource

get_attributes()

Get all the attributes of the current object

list_attachments()

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)

Bases: taiga.models.models.Attachment

TaskAttachment model

delete()

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)

Bases: taiga.models.models.Attachments

TaskAttachments factory

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

Create a new Attachment.

Parameters:
  • projectProject id
  • object_id – id of the current object
  • refTask 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:

<SearchableList>

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)

Bases: taiga.models.models.CustomAttribute

TaskAttribute model

delete()

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)

Bases: taiga.models.models.CustomAttributes

TaskAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:
  • projectProject 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Task Status model

Parameters:
delete()

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.Tasks(requester)

Bases: taiga.models.base.ListResource

Tasks factory

create(project, subject, status, **attrs)

Create a new Task.

Parameters:
  • projectProject id
  • subject – subject of the Task
  • status – status of the Task
  • attrs – optional attributes of the 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

User model

delete()

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

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)

Bases: taiga.models.base.ListResource

UserStories factory class

create(project, subject, **attrs)

Create a new UserStory.

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

<SearchableList>

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)

Bases: taiga.models.models.CustomAttributeResource, taiga.models.models.CommentableResource

User Story model

Parameters:
add_comment(comment)

Add a comment to the current element

Parameters:comment – the comment you want to insert
add_task(subject, status, **attrs)

Add a Task to the current UserStory and return it. :param subject: subject of the Task :param status: status of the Task :param attrs: optional attributes for Task

attach(attached_file, **attrs)

Attach a file to the UserStory

Parameters:
  • attached_file – file path to attach
  • attrs – optional attributes for the attached file
delete()

Delete the current InstanceResource

get_attributes()

Get all the attributes of the current object

list_attachments()

Get a list of UserStoryAttachment.

list_tasks()

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)

Bases: taiga.models.models.Attachment

UserStoryAttachment class

delete()

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)

Bases: taiga.models.models.Attachments

UserStoryAttachments factory class

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

Create a new Attachment.

Parameters:
  • projectProject id
  • object_id – id of the current object
  • refTask 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:

<SearchableList>

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)

Bases: taiga.models.models.CustomAttribute

UserStoryAttribute model

delete()

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)

Bases: taiga.models.models.CustomAttributes

UserStoryAttributes factory

create(project, name, **attrs)

Create a new CustomAttribute.

Parameters:
  • projectProject 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Taiga User Story Status model

Parameters:
delete()

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.Users(requester)

Bases: taiga.models.base.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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

Webhook model

Parameters:
  • requesterRequester instance
  • name – name of the Webhook
  • url – payload url of the Webhook
  • key – secret key of the Webhook
delete()

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)

Bases: taiga.models.base.ListResource

Webhooks factory

create(project, name, url, key, **attrs)

Create a new Webhook

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

<SearchableList>

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)

Bases: taiga.models.models.Attachment

WikiAttachment model

delete()

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)

Bases: taiga.models.models.Attachments

WikiAttachments factory

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

Create a new Attachment.

Parameters:
  • projectProject id
  • object_id – id of the current object
  • refTask 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:

<SearchableList>

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.

Bases: taiga.models.base.InstanceResource

WikiLink model

Parameters:
  • projectProject id
  • title – title of the wiki link
  • href – href for the wiki link
  • order – order of the wiki link
delete()

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

Bases: taiga.models.base.ListResource

WikiLinks factory

create(project, title, href, **attrs)

Create a new WikiLink

Parameters:
  • projectProject 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:

<SearchableList>

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)

Bases: taiga.models.base.InstanceResource

WikiPage model

Parameters:
  • projectProject id
  • slug – slug of the wiki page
  • content – content of the wiki page
  • watchers – list of watchers id
attach(attached_file, **attrs)

Attach a file to the WikiPage

Parameters:
  • attached_file – file path to attach
  • attrs – optional attributes for the attached file
delete()

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.WikiPages(requester)

Bases: taiga.models.base.ListResource

WikiPages factory

create(project, slug, content, **attrs)

create a new WikiPage

Parameters:
  • projectProject 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:

<SearchableList>

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.

Indices and tables