Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d6o/BrazilianFootball
Display data about Brazilian football games that will occur in the next few days
https://github.com/d6o/BrazilianFootball
api brazil brazilian football football-data footballdata go golang golang-application golang-library golang-tools golang-wrapper soccer soccer-matches
Last synced: about 1 month ago
JSON representation
Display data about Brazilian football games that will occur in the next few days
- Host: GitHub
- URL: https://github.com/d6o/BrazilianFootball
- Owner: d6o
- License: mit
- Created: 2017-04-02T19:41:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-04-02T22:42:26.000Z (over 7 years ago)
- Last Synced: 2024-11-02T19:06:01.922Z (about 2 months ago)
- Topics: api, brazil, brazilian, football, football-data, footballdata, go, golang, golang-application, golang-library, golang-tools, golang-wrapper, soccer, soccer-matches
- Language: Go
- Size: 6.84 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-brazil-data - BrazilianFootball
README
# BrazilianFootball    
Display data about Brazilian football games that will occur in the next few days.
**Table of Contents**
- [Demo](#demo)
- [Project Status](#project-status)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Get 5 matches](#get-5-matches)
- [Get 10 matches](#get-10-matches)
- [Filter by Team](#filter-by-team)
- [Filter by Championship](#filter-by-championship)
- [Filter by Date](#filter-by-date)
- [Filter by Hour](#filter-by-hour)
- [Filter by Date and Hour](#filter-by-date-and-hour)
- [Filter by Location](#filter-by-location)
- [Filter by Round phase](#filter-by-round-phase)
- [Filter by Status](#filter-by-status)
- [Show only today matches](#show-only-today-matches)
- [Hide Finished matches](#hide-finished-matches)
- [Show help](#show-help)
- [Contributing](#contributing)
- [Bug Reports & Feature Requests](#bug-reports--feature-requests)
- [Developing](#developing)
- [Social Coding](#social-coding)
- [License](#license)
## Demo
[](https://asciinema.org/a/a0m1ln1k1u2ibbh1n4mbty1do)
## Project Status
BrazilianFootball is on beta. Pull Requests [are welcome](https://github.com/DiSiqueira/BrazilianFootball#social-coding)
## Features
- Open source - You can check out our code
- Secure
- Always up-to-date
- Use decimal type
- 100% satisfaction guaranteed
- It's perfect to keep up-to-date with all football matches
- STUPIDLY [EASY TO USE](https://github.com/DiSiqueira/BrazilianFootball#usage)
- Very fast start up and response time
- Uses native libs
- Colorful
## Installation
### Option 1: Go Get
```bash
$ go get github.com/disiqueira/BrazilianFootball
```
## Usage
### Get 5 matches
```bash
$ BrazilianFootball
```
### Get 10 matches
```bash
$ BrazilianFootball -limit=10
```
### Filter by Team
```bash
$ BrazilianFootball -team="Corinthians"
```
### Filter by Championship
```bash
$ BrazilianFootball -championship="Campeonato Paulista"
```
### Filter by Date
```bash
$ BrazilianFootball -date="02/04/2017"
```
### Filter by Hour
```bash
$ BrazilianFootball -hour="10:00"
```
### Filter by Date and Hour
```bash
$ BrazilianFootball -date="02/04/2017" -hour="10:00"
```
### Filter by Filter by Day of week
```bash
$ BrazilianFootball -dayOfWeek="Dom"
```
### Filter by Location
```bash
$ BrazilianFootball -location="Arena Joinville"
```
### Filter by Round phase
```bash
$ BrazilianFootball -phase="6ª rodada"
```
### Filter by Status
```bash
$ BrazilianFootball -status="Encerrada"
```
### Show only today matches
```bash
$ BrazilianFootball -today=true
```
### Hide Finished matches
```bash
$ BrazilianFootball -upcoming=true
```
### Show Help
```bash
# Show help
$ BrazilianFootball -h
```
## Program help
## Contributing
### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/DiSiqueira/BrazilianFootball/issues) to report any bugs or file feature requests.
### Developing
PRs are welcome. To begin developing, do this:
```bash
$ git clone https://github.com/disiqueira/BrazilianFootball.git BrazilianFootball
$ cd BrazilianFootball/
$ go get -v -d
```
## Social Coding
1. Create an issue to discuss about your idea
2. [Fork it](https://github.com/DiSiqueira/BrazilianFootball/fork)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
7. Profit! :white_check_mark:
## License
The MIT License (MIT)
Copyright (c) 2013-2017 Diego Siqueira
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.