owenvoke / gitea
An object oriented PHP wrapper for the Gitea API
Fund package maintenance!
owenvoke
ecologi.com/owenvoke?gift-trees
Requires
- php: ^7.4 || ^8.0
- php-http/client-common: ^2.3
- php-http/discovery: ^1.12
- php-http/httplug: ^2.2
- php-http/multipart-stream-builder: ^1.1
- psr/http-client-implementation: ^1.0
- psr/http-factory-implementation: ^1.0
- psr/http-message: ^1.0
Requires (Dev)
- guzzlehttp/guzzle: ^7.2.0
- guzzlehttp/psr7: ^1.6
- http-interop/http-factory-guzzle: ^1.0
- pestphp/pest: ^1.0
- php-http/mock-client: ^1.4
- phpstan/phpstan: ^0.12.81
- symfony/var-dumper: ^5.1
README
An object oriented PHP wrapper for the Gitea API
Requirements
- PHP >= 8.2
- A PSR-17 implementation
- A PSR-18 implementation
Install
Via Composer
composer require owenvoke/gitea guzzlehttp/guzzle:^7.9 http-interop/http-factory-guzzle:^1.2
We are decoupled from any HTTP messaging client with help by HTTPlug.
Usage
Basic usage
// Include the Composer autoloader require_once __DIR__ . '/vendor/autoload.php'; $client = new \OwenVoke\Gitea\Client(); $repositories = $client->user()->repositories();
Authentication
Note: Gitea only supports authentication via an API token.
use OwenVoke\Gitea\Client; $client = new Client(); $client->authenticate($apiToken, null, Client::AUTH_ACCESS_TOKEN);
Self-hosted Gitea instances
The Gitea PHP wrapper can be configured to use a custom-hosted instance, rather than gitea.com
.
// Specify the URL of the Gitea instance on client initialization $client = new \OwenVoke\Gitea\Client(null, null, 'https://gitea.example.com');
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.
Credits
- Owen Voke
- KNP Labs (based on their GitHub client)
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Treeware
You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees here.
Read more about Treeware at treeware.earth.