https://github.com/owenvoke/torrent-php
A set of torrent management classes with support for Torrent v2. (WIP)
https://github.com/owenvoke/torrent-php
php torrent torrent-v2
Last synced: about 1 year ago
JSON representation
A set of torrent management classes with support for Torrent v2. (WIP)
- Host: GitHub
- URL: https://github.com/owenvoke/torrent-php
- Owner: owenvoke
- License: mit
- Created: 2017-09-21T15:03:02.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2022-11-18T11:20:41.000Z (over 3 years ago)
- Last Synced: 2025-03-28T02:38:22.219Z (over 1 year ago)
- Topics: php, torrent, torrent-v2
- Language: PHP
- Homepage: https://packagist.org/packages/owenvoke/torrent
- Size: 94.7 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Torrent
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Static Analysis][ico-static-analysis]][link-static-analysis]
[![Total Downloads][ico-downloads]][link-downloads]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
A set of torrent management classes with support for BitTorrent v2.
## Install
Via Composer
```shell
composer require owenvoke/torrent
```
## Usage
See [BEP52] for more information on the BitTorrent v2 proposal.
_Please note, this is still a work-in-progress, and is by no means usable at the moment._
In future, this will be a standalone library, the CLI will be distributed separately.
**List available commands**
```shell
torrent
```
**Create a torrent file for a file or directory**
```shell
torrent create 'file_or_directory'
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
```shell
composer test
```
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.
## Credits
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) 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][link-treeware-gifting].
Read more about Treeware at [treeware.earth][link-treeware].
[ico-version]: https://img.shields.io/packagist/v/owenvoke/torrent.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/workflow/status/owenvoke/torrent/Tests.svg?style=flat-square
[ico-static-analysis]: https://img.shields.io/github/workflow/status/owenvoke/skeleton-php/Static%20Analysis.svg?style=flat-square&label=Static%20Analysis
[ico-downloads]: https://img.shields.io/packagist/dt/owenvoke/torrent.svg?style=flat-square
[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square
[link-packagist]: https://packagist.org/packages/owenvoke/torrent
[link-github-actions]: https://github.com/owenvoke/torrent/actions
[link-static-analysis]: https://github.com/owenvoke/skeleton-php/actions/workflows/static.yml
[link-downloads]: https://packagist.org/packages/owenvoke/torrent
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: ../../contributors
[BEP52]: https://github.com/bittorrent/bittorrent.org/blob/master/beps/bep_0052.rst