tomegantech/packagist-client

用于操作 Packagist.org REST API 的客户端

维护者

详细信息

github.com/tkegan/PackagistClient

源代码

问题

安装: 2

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

v1.0.0 2021-02-21 15:39 UTC

Requires

Requires (Dev)

MIT 2fded1307ed7422aed68daddc1f6cdabff04a93d

  • Tom Egan <tom.woop@tomegan.tech>

This package is auto-updated.

Last update: 2024-09-21 23:43:52 UTC

README

关于

PHP 中用于操作 Packagist REST API 的客户端库。

请注意，此库并非由 Pakagist.org 背后的团队提供，而是由阅读了 API 文档并认为拥有一个库可以简化 API 使用的人提供的。因此，此库未经 Packagist 推荐且可能会因 Packagist API 的更改而失效。

作者

Tom Egan tom@tomegan.tech

许可证

本项目采用 MIT 许可证 - 详细信息请参阅 LICENSE 文件

安装

使用以下命令安装最新版本：

$ composer require tomegantech/packagist-client

用法

通过创建一个 PackagistClient 实例并调用 API 覆盖方法之一来使用此库

  • listPackages(string|null $organization, string|null $type)
  • listSecurityAdvisories(DateTime|null $since, string[]|null $packages)
  • searchPackages(string|null $term, string|null $tag, string|null $type)

例如

use GuzzleHttp\Client as HttpClient;
use TomEganTech\PackagistClient\PackagistClient;

...

$client = new PackagistClient(new HttpClient());
$securityAdvisories = $client->listSecurityAdvisories(null, ['monolog/monolog']);

还可以查看 test/PackagistClientTest.php 以获取更多示例。

测试

包含一个单元测试套件用于测试 PHP 代码。要使用它，您需要 phpunit 和生成 PSR-4 自动加载映射。这可以使用 composer 完成。要获取 composer，请遵循 https://getcomposer.org.cn 上的 os 指令。安装 composer 后，只需将项目目录切换到项目目录并运行 composer install。然后您可以使用 composer 安装的 phpunit 运行测试。

cd ${PROJECT_DIRECTORY}
composer install
vendor/bin/phpunit test

贡献

您发现了错误吗？请随时打开一个 问题。您有修复或增强的代码？当然，我很想看看；请打开一个 pull request。