spatie / Packagist Api
Projects that are alternatives of or similar to Packagist Api
Fetch package info from Packagist
This package makes it easy to search and fetch package info using the Packagist API.
Support us
Learn how to create a package like this one, by watching our premium video course:
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/packagist-api
There is also a Laravel wrapper available for this package.
Usage
You must pass a Guzzle client and a url generator to the constructor of Spatie\Packagist\PackagistClient
.
$client = new \GuzzleHttp\Client();
$generator = new \Spatie\Packagist\PackagistUrlGenerator();
$packagist = new \Spatie\Packagist\PackagistClient($client, $generator);
List package names
// All packages
$packagist->getPackagesNames();
// List packages by type.
$packagist->getPackagesNamesByType('composer-plugin');
// List packages by organization
$packagist->getPackagesNamesByVendor('spatie');
Searching for packages
// Search packages by name.
$packagist->searchPackagesByName('packagist');
// Search packages by tag.
$packagist->searchPackagesByTags('psr-3');
// Search packages by type.
$packagist->searchPackagesByType('composer-plugin');
// Combined search.
$packagist->searchPackages('packagist', ['type' => 'library']);
Pagination
Searching for packages returns a paginated result. You can change the pagination settings by adding more parameters.
// Get the third page, 10 items per page.
$packagist->searchPackagesByName('packagist', 3, 10);
Getting package data.
// Using the Composer metadata. (faster, but less data)
$packagist->getPackageMetadata('spatie/packagist-api');
$packagist->getPackageMetadata('spatie', 'packagist-api');
// Using the API. (slower, cached for 12 hours by Packagist.
$packagist->getPackage('spatie/packagist-api');
$packagist->getPackage('spatie', 'packagist-api');
Get Statistics
$packagist->getStatistics();
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.