Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mborne/remote-git
A lightweight PHP client providing a consistent access to hosted and self-hosted git repositories (github, gitlab, gogs and gitea)
https://github.com/mborne/remote-git
client client-library git gitea github gitlab gogs php
Last synced: 21 days ago
JSON representation
A lightweight PHP client providing a consistent access to hosted and self-hosted git repositories (github, gitlab, gogs and gitea)
- Host: GitHub
- URL: https://github.com/mborne/remote-git
- Owner: mborne
- License: mit
- Created: 2018-11-25T17:40:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-23T10:12:56.000Z (8 months ago)
- Last Synced: 2024-04-24T13:36:37.527Z (7 months ago)
- Topics: client, client-library, git, gitea, github, gitlab, gogs, php
- Language: PHP
- Homepage:
- Size: 104 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mborne/remote-git
[](https://github.com/mborne/remote-git/actions/workflows/ci.yml) [](https://coveralls.io/github/mborne/remote-git?branch=master)
## Description
A lightweight PHP client providing a consistent access to hosted and self-hosted git repositories (github, gitlab, gogs and gitea).
## Use cases
Note that a small set of features is prefered here to a rich API integration to allow homogenous access to remote hosting services.
The original development has been realized in [mborne/satis-gitlab](https://github.com/mborne/satis-gitlab) repository to **generate a config file referencing git repositories**.
This module is also used by [mborne/git-manager](https://github.com/mborne/git-manager#git-manager) to **backup and analyse git repositories** (for example that following files are present : README.md, LICENSE,...)
## Features
* List repositories from multiple GIT hosting services filtering by
* usernames
* organizations/groups
* Get raw files from repositories
* Apply custom filter
* Project contains a given file (`RequiredFileFilter`)
* Project is a composer project (`ComposerProjectFilter`)
* Project name doesn't match a given regexp (`IgnoreRegexpFilter`)
## Requirements
* [PHP >= 8.1](https://www.php.net/supported-versions.php)
## Supported GIT hosting services
| Type | Description |
| --------- | ------------------------------------------------------------------------ |
| gitlab-v4 | [gitlab.com](https://about.gitlab.com/) and self hosted gitlab instances |
| github | [github.com](https://github.com) |
| gogs-v1 | [Gogs](https://gogs.io/) or [Gitea](https://gitea.io/) |
## Usage
### Create a client
```php
// configure client
$clientOptions = new ClientOptions();
$clientOptions
->setUrl('https://github.com')
->setToken($token)
;
// create client
$client = ClientFactory::createClient(
$clientOptions,
new NullLogger()
);
```
### Filter by usernames or orgs/groups
```php
$options = new FindOptions();
// Use '_me_' on github to include private repositories
$options->setUsers(array('mborne'));
$options->setOrganizations(array('symfony','FriendsOfSymfony'));
$projects = $client->find($options);
```
### Filter according to composer.json
```php
$options = new FindOptions();
$options->setUsers(array('mborne'));
$filter = new ComposerProjectFilter($client);
$filter->setType('library');
$options->setFilter($filter);
$projects = $client->find($options);
```
### Compose filters
```php
$options = new FindOptions();
$options->setUsers(array('mborne'));
$filterCollection = new FilterCollection();
// filter according to composer.json
$composerFilter = new ComposerProjectFilter($client);
$composerFilter->setType('library');
$filterCollection->addFilter($composerFilter);
// filter according to README.md
$filterCollection->addFilter(new RequiredFileFilter(
$client,
'README.md'
));
$options->setFilter($filterCollection);
$projects = $client->find($options);
```
## Dependencies
* [guzzlehttp/guzzle - 7.x](https://packagist.org/packages/guzzlehttp/guzzle)
* [psr/log](https://packagist.org/packages/psr/log)
## License
[MIT](LICENSE)
## Testing
* Configure access token for github.com and gitlab.com APIs (optional) :
```bash
# see https://github.com/settings/tokens
export GITHUB_TOKEN=AnyGithubToken
# see https://gitlab.com/-/profile/personal_access_tokens
export GITLAB_TOKEN=AnyGitlabToken
```
* Install dependencies and run tests :
```bash
make test
# Alternative :
# composer install
# vendor/bin/phpunit -c phpunit.xml.dist
```
Note that an HTML coverage report is generated to `output/coverage/index.html`