Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owenvoke/rugby-schedule
Rugby schedules on the command-line
https://github.com/owenvoke/rugby-schedule
cli command-line laravel-zero php rugby
Last synced: 2 days ago
JSON representation
Rugby schedules on the command-line
- Host: GitHub
- URL: https://github.com/owenvoke/rugby-schedule
- Owner: owenvoke
- License: mit
- Created: 2022-03-17T15:36:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T14:50:58.000Z (4 months ago)
- Last Synced: 2024-08-04T01:18:52.749Z (3 months ago)
- Topics: cli, command-line, laravel-zero, php, rugby
- Language: PHP
- Homepage: https://packagist.org/packages/owenvoke/rugby-schedule
- Size: 40.1 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-laravel-zero - Rugby Schedule - line. (Projects using Laravel Zero)
README
# Rugby Schedule
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Static Analysis][ico-static-analysis]][link-static-analysis]
[![Total Downloads][ico-downloads]][link-downloads]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
**Rugby Schedule** is a command-line tool that keeps you up to date with rugby tournament schedules.
## Install
> Requires PHP 8.2 or later
Via Composer
```shell
composer global require owenvoke/rugby-schedule
```
Via Docker
```shell
docker run --rm ghcr.io/owenvoke/rugby-schedule:latest
```
## Usage
### Tournaments
The following tournament commands are available:
#### Men's Rugby
- `autumn-nations` - [The Autumn Nations Series](https://autumnnationsseries.com)
- `european-challenge` - [The European Challenge Cup](https://epcrugby.com/challenge-cup)
- `european-champions` - [The European Champions Cup](https://epcrugby.com)
- `lions` - [The British & Irish Lions Tour](https://www.lionsrugby.com)
- `premiership` - [The Gallagher Premiership](https://premiershiprugby.com/gallagher-premiership)
- `premiership-cup` - [The Gallagher Premiership Cup](https://premiershiprugby.com/premiership-rugby-cup)
- `six-nations` - [Six Nations](https://sixnationsrugby.com)
- `united-rugby-championship` - [United Rugby Championship](https://www.unitedrugby.com)
#### Women's Rugby
- `womens:six-nations` - [Women's Six Nations](https://womens.sixnationsrugby.com)
#### Under-18s Rugby
- `u18s:premiership` - [Premiership Rugby Under-18s Academy League](https://premiershiprugby.com/under-18-academy-league)
#### Under-20s Rugby
- `u20s:six-nations` - [Under-20s Six Nations](https://u20.sixnationsrugby.com)
See the output of `rugby-schedule` for all available commands and their usage, or use `--help` to display extended usage information for a specific command.
### Viewing Matches for a Specific Team
The `--team` (or `-t`) flag can be used to filter to a specific team (e.g. `--team england`).
This flag is available on all commands, however it may not be supported on all competitions.
### Viewing Calendar Links
You can view available calendar links (e.g. Google Calendar, Outlook Calendar) that allow you to add an event to your calendar.
To do this, include the `--include-calendar-links` (or `-c`) flag when calling a command.
### Viewing Past Matches
By default, past matches are excluded from the output. These can be included if necessary by using the `--include-past` (or `-p`) flag when calling a command.
## 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 [email protected] 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/rugby-schedule.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-static-analysis]: https://img.shields.io/github/actions/workflow/status/owenvoke/rugby-schedule/static.yml?branch=main&style=flat-square&label=Static%20Analysis
[ico-downloads]: https://img.shields.io/packagist/dt/owenvoke/rugby-schedule.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/rugby-schedule
[link-static-analysis]: https://github.com/owenvoke/rugby-schedule/actions
[link-downloads]: https://packagist.org/packages/owenvoke/rugby-schedule
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: ../../contributors