# PHP YouTrack SDK
## Introduction
YouTrack PHP Software Development Kit provides set of tools to interact with [JetBrains YouTrack Issue Tracking and Project Management software](https://www.jetbrains.com/youtrack/).
## Contents
- [Features](#features)
- [Requirements](#requirements)
- [Provides packages](#provides-packages)
- [Frameworks support](#frameworks-support)
- [Installation](#installation)
- [Usage](#usage)
- [API client](#api-client)
- [Change log](#change-log)
- [Contributing](#contributing)
- [Testing](#testing)
- [Security](#security)
- [Contributors](#contributors)
- [Alternatives](#alternatives)
- [License](#license)
- [About CyberCog](#about-cybercog)
## Features
- Framework agnostic.
- Using contracts to keep high customization capabilities.
- YouTrack Entities with relationships.
- Multiple authorization strategies: Token, Cookie.
- Following PHP Standard Recommendations:
- [PSR-1 (Basic Coding Standard)](http://www.php-fig.org/psr/psr-1/).
- [PSR-2 (Coding Style Guide)](http://www.php-fig.org/psr/psr-2/).
- [PSR-4 (Autoloading Standard)](http://www.php-fig.org/psr/psr-4/).
- [PSR-7 (HTTP Message Interface)](http://www.php-fig.org/psr/psr-7/).
- Covered with unit tests.
## Requirements
- YouTrack >= 3.0 with REST-API enabled (always enabled, by default)
- PHP >= 7.1
- Guzzle HTTP Client >= 6.2
## Provides packages
- [YouTrack REST API PHP Client](https://github.com/cybercog/youtrack-rest-php#readme) maintained by [Anton Komarev](https://github.com/a-komarev)
**Haven't found required functionality? [We are open](CONTRIBUTING.md) for Pull Requests!**
## Frameworks support
PHP YouTrack SDK is framework agnostic package and could be easily used in any PHP framework you want.
### Framework integrations list
- [Laravel YouTrack SDK](https://github.com/cybercog/laravel-youtrack-sdk#readme) maintained by [Anton Komarev](https://github.com/a-komarev)
**Haven't found your favorite framework in the list? [We are open](CONTRIBUTING.md) for Pull Requests!**
## Installation
The preferred method is via [composer](https://getcomposer.org). Follow the
[installation instructions](https://getcomposer.org/doc/00-intro.md) if you do not already have
composer installed.
Once composer is installed, execute the following command in your project root to install this library:
```sh
$ composer require cybercog/youtrack-php-sdk
```
### Without framework
Be sure to include the autoloader in your project:
```php
require_once '/path/to/your-project/vendor/autoload.php';
```
## Usage
### API client
[YouTrack REST API PHP Client package documentation](https://github.com/cybercog/youtrack-php-sdk/wiki/PHP-YouTrack-REST).
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Testing
Run the tests with:
```sh
$ composer test
```
## Security
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.
## Contributors
| 
Anton Komarev |
| :---: |
[PHP YouTrack SDK contributors list](../../contributors)
## Alternatives
*Feel free to add more alternatives as Pull Request.*
## License
- `PHP YouTrack SDK` package is open-sourced software licensed under the [MIT License](LICENSE).
## About CyberCog
[CyberCog](http://www.cybercog.ru) is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.
- [Follow us on Twitter](https://twitter.com/cybercog)
- [Read our articles on Medium](https://medium.com/cybercog)
