API¶

The internal API is internal at the moment and - though it can be used for interacting with the YouTrack REST API using an object oriented interface - is not supported.

Connection¶

class pyutrack.connection.Connection(base_url=None, credentials=None)[source]¶

api_url¶

base_url¶

credentials¶

delete(*args, **kwargs)[source]¶

get(*args, **kwargs)[source]¶

login(persist_credentials=True)[source]¶

post(*args, **kwargs)[source]¶

put(*args, **kwargs)[source]¶

class pyutrack.connection.Credentials(username, password=None, cookies=None)[source]¶

KEYRING_COOKIE = 'pyutrack:cookies'¶

KEYRING_PASSWORD = 'pyutrack:password'¶

cookies¶

static from_keyring(username)[source]¶

load_from_keyring()[source]¶

password¶

persist()[source]¶

reset_cookies()[source]¶

reset_password()[source]¶

username¶

pyutrack.connection.fix_auth(meth)[source]¶

Resource Types¶

class pyutrack.resources.Group(connection, hydrate=False, **fields)[source]¶

classmethod create(connection, name, auto_join=False, description='')¶: create group

delete()¶: delete group

get()¶: get group

get_roles()¶: get group roles

classmethod list(connection)¶: list group

roles¶: group roles

update(description, auto_join, new_name)¶: update group

class pyutrack.resources.Issue(connection, hydrate=False, **fields)[source]¶

assignee¶

command(command=None, comment=None)[source]¶

executes a command for the given issue.

Parameters:	command (str) – The youtrack command to execute. See https://www.jetbrains.com/help/youtrack/standalone/Commands.html for command grammar.

classmethod create(connection, project, description='', summary='')¶: create issue

delete()¶: delete issue

get()¶: get issue

get_issue_links()¶: get issue issue_links

id¶

issue_links¶: issue issue_links

link¶

classmethod list(connection, filter, max=100)¶: list issue

priority¶

reporter¶

status¶

update(description='', summary='')¶: update issue

updater¶

class pyutrack.resources.IssueLink(connection, hydrate=False, **fields)[source]¶

class pyutrack.resources.IssueLinkType(connection, hydrate=False, **fields)[source]¶

classmethod create(connection, outward_name, inward_name, directed=False)¶: create issuelinktype

delete()¶: delete issuelinktype

get()¶: get issuelinktype

classmethod list(connection)¶: list issuelinktype

update(new_name='', inward_name='', directed='', outward_name='')¶: update issuelinktype

class pyutrack.resources.Permission(connection, hydrate=False, **fields)[source]¶

classmethod list(connection)¶: list permission

class pyutrack.resources.Project(connection, hydrate=False, **fields)[source]¶

classmethod create(connection, project_name, project_lead_login, project_id=None, description='', starting_number=1)¶: create project

delete()¶: delete project

description¶

get()¶: get project

get_issues(filter='', max=100)¶: get project issues

id¶

issues¶: project issues

lead¶

classmethod list(connection)¶: list project

class pyutrack.resources.Role(connection, hydrate=False, **fields)[source]¶

classmethod create(connection, name, description='')¶: create role

delete()¶: delete role

get()¶: get role

get_permissions()¶: get role permissions

classmethod list(connection)¶: list role

permissions¶: role permissions

update(description, new_name)¶: update role

class pyutrack.resources.User(connection, hydrate=False, **fields)[source]¶

classmethod create(connection, login, full_name, email, password)¶: create user

delete()¶: delete user

get()¶: get user

get_groups()¶: get user groups

get_roles()¶: get user roles

groups¶: user groups

classmethod list(connection, project='', query='', role='', group='', permission='')¶: list user

roles¶: user roles

update(login='', password='', full_name='', email='')¶: update user