An open API service indexing awesome lists of open source software.

https://github.com/toshy/bunnynet-php

Bunny.net CDN API PHP library.
https://github.com/toshy/bunnynet-php

bunny bunnycdn bunnycdn-php bunnyhop bunnynet bunnynet-php bunnyphp php

Last synced: 26 days ago
JSON representation

Bunny.net CDN API PHP library.

Awesome Lists containing this project

README

          




Bunny CDN Logo

# BunnyNet API client for PHP


Current bundle version
Packagist Total Downloads
PHP version requirement
PHP-FIG PSR-18
Code style
Mess detector
Static analysis
Unit tests
Security

Bunny.net is content delivery platform that truly hops: providing CDN,
edge storage, video streaming, image optimizers and much more!

> [!IMPORTANT]
> This is a non-official PHP library for the [Bunny.net API](https://docs.bunny.net/docs).

## 🧰 Install

```bash
composer require toshy/bunnynet-php:^9.0
```

## 📜 Documentation

The documentation is available at [https://toshy.github.io/BunnyNet-PHP](https://toshy.github.io/BunnyNet-PHP).

## 🛠️ Contribute

Features and bugfixes should be based on the `master` branch.

### Prerequisites

* [Docker Compose](https://docs.docker.com/compose/install/)
* [Task (optional)](https://taskfile.dev/installation/)

### Install dependencies

```shell
task composer:install
```

### Enable pre-commit hook

```shell
task git:hooks
```

> [!NOTE]
> Checks for `phpcs`, `phpstan`, `phpmd` and `phpunit` are executed when committing.
> You can also run these checks with `task contribute`.

### 🤖 Automated PRs

This repository has a workflow run (see [generator](.github/workflows/generator.yml)) that creates or updates existing [models](src/Model/API) based on the latest OpenAPI specifications and subsequently
creates a (draft) PR for these changes. You can identify these automated PRs with the labels `OpenAPI` and `automated`.

The automated PRs contain two tasks:
- [x] Add/Update API models
- [ ] Add/Update documentation examples (when needed)

The first task is already done by the generator, but if you want to fix the other task, please use the following way of working.

1. Fork the repository and make sure to copy all branches (not just `master`).
2. Create a branch based on the automated PR branch.
- The automated branches will be named `generator/update-api-models`.
3. Make the desired changes in your own branch.
4. Create a PR with your branch, denote your changes and reference the existing automated (draft) PR.

## ❕ Licence

This repository comes with a [MIT license](./LICENSE).