shakahl / pharover
Command line tool to send push notifications through the Pushover service.
Requires
- php: >=5.6.0
- symfony/console: ^2.7
- symfony/process: ^2.7
Requires (Dev)
- phpunit/phpunit: 4.*
This package is not auto-updated.
Last update: 2024-12-21 20:02:16 UTC
README
Command line tool to send push notifications through the Pushover service.
Table of contents
- Features overview
- Requirements
- Installation
- Configuration
- Usage example
- Unit testing with PHPUnit
- Known Bugs
- Contributing
- Credits
- Donation
- License
Features overview
- DRY concept
- Unit testing with PHPUnit ** CLI commands with Symphony Console Component
Requirements
The following versions of PHP are supported by this version.
- PHP 5.5
- PHP 5.6
- HHVM
Installation
https://packagist.org/packages/shakahl/pharover
Add shakahl/pharover
as a requirement to composer.json
:
{ "require": { "shakahl/pharover": "dev-master" } }
Update your packages with composer update
or install with composer install
.
You can also add the package using composer require shakahl/pharover
and later specifying the version you want (for now, dev-master
is your best bet).
Configuration
You must specify your Pullover API credentials in a .pharover.json
file.
{ "user-key" : "", "token-key" : "" }
The file can be placed:
- To your HOME directory.
- To the current working directory.
- To the directory containing the
pharover.phar
.
Usage example
$ php pharover.phar notification:send "test message" --title="Pharover" --url="https://github.com/shakahl/pharover" --url-title="Pharover on GitHub"
Unit testing with PHPUnit
Make sure about all composer dependencies are installed already.
$ composer install
Usage under Windows
$ vendor/bin/phpunit.bat
Usage under Linux
$ vendor/bin/phpunit
Building
Pharover can be built with the Box2
$ composer install --no-dev $ box build
Known Bugs
There aren't any known issues yet.
Contributing
See CONTRIBUTING.md
file.
Credits
This package was originally created by Soma Szélpál.
Donation
You can support contributors of this project individually. Every contributor is welcomed to add his/her line below with any content. Ordering shall be alphabetically by GitHub username.
License
This project is released under the MIT License.