https://github.com/devopshq/youtrack

YouTrack Python 3 Client Library
https://github.com/devopshq/youtrack

jetbrains python python-library youtrack

Last synced: 2 months ago
JSON representation

YouTrack Python 3 Client Library

• Host: GitHub
• URL: https://github.com/devopshq/youtrack
• Owner: devopshq
• License: mit
• Created: 2016-10-14T16:47:07.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-15T12:57:51.000Z (about 4 years ago)
• Last Synced: 2025-06-15T19:11:40.051Z (4 months ago)
• Topics: jetbrains, python, python-library, youtrack
• Language: Python
• Homepage: https://devopshq.github.io/youtrack/
• Size: 78.1 KB
• Stars: 27
• Watchers: 9
• Forks: 14
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
YouTrack Python 3 Client Library

================================

[![build](https://travis-ci.org/devopshq/youtrack.svg?branch=master)](https://travis-ci.org/devopshq/youtrack) [![pypi](https://img.shields.io/pypi/v/dohq-youtrack.svg)](https://pypi.python.org/pypi/dohq-youtrack) [![codacy](https://api.codacy.com/project/badge/Grade/9f6d2c74eb1a4d798b87bd05bed6ee21)](https://www.codacy.com/app/devopshq/youtrack) [![license](https://img.shields.io/pypi/l/dohq-youtrack.svg)](https://github.com/devopshq/youtrack/blob/master/LICENSE)

This document describes Python 3 library that wraps YouTrack REST API.

Compatibility

Current implementation of the YouTrack Python 3 Client Library and scripts is compatible with YouTrack 3.x and higher REST API and Python 3.

Installation

------------

To install YouTrack Python 3 Client Library:

```python

  pip install dohq-youtrack

```

Authenticating

--------------

```python

  from youtrack.connection import Connection

  connection = Connection('http://teamsys.intellij.net', 'xxx', 'xxx')

```

Get Issues

----------

```python

  # get one issue

  connection.get_issue('SB-1')

```

```python

  # get first 10 issues in project JT for query 'for: me #unresolved'

  connection.get_issues('JT', 'for: me #unresolved', 0, 10)

  # get issues from all projects

  connection.get_all_issues('for: me #unresolved', 0, 10)

```

Create Issue

------------

```python

  connection.create_issue('SB', 'resttest', 'Test issue', 'Test description', '2', 'Bug', 'First', 'Open', '', '', '')

```

Other Methods

-------------

See method of class Connection in [youtrack/connection.py](https://github.com/devopshq/youtrack/blob/master/youtrack/connection.py)