Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prasadg193/covaccine-notifier
CoWIN Vaccine availability notifier for India
https://github.com/prasadg193/covaccine-notifier
availability-monitor covaccine-notifier covid-19 cowin-portal district email-notification india notifier telegram vaccination vaccine-availability vaccine-finder vaccine-tracker
Last synced: 3 months ago
JSON representation
CoWIN Vaccine availability notifier for India
- Host: GitHub
- URL: https://github.com/prasadg193/covaccine-notifier
- Owner: PrasadG193
- License: apache-2.0
- Created: 2021-05-02T16:49:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-27T03:51:29.000Z (over 3 years ago)
- Last Synced: 2024-10-16T08:51:56.997Z (3 months ago)
- Topics: availability-monitor, covaccine-notifier, covid-19, cowin-portal, district, email-notification, india, notifier, telegram, vaccination, vaccine-availability, vaccine-finder, vaccine-tracker
- Language: Go
- Homepage:
- Size: 2.13 MB
- Stars: 62
- Watchers: 5
- Forks: 28
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# covaccine-notifier
CoWIN Portal Vaccine availability notifier
covaccine-notifier periodically checks and sends email notifications for available slots for the next 7 days on CoWIN portal in a given area and age.
**Sample screenshot**
## Installation
### Install the pre-compiled binary
```
curl -sfL https://raw.githubusercontent.com/PrasadG193/covaccine-notifier/main/install.sh | sh
```
### Docker
```
docker pull ghcr.io/prasadg193/covaccine-notifier:v0.2.0
```
## Usage
covaccine-notifier can monitor vaccine availability either by pin-code or state and district names
```bash
$ ./covaccine-notifier --help
CoWIN Vaccine availability notifier India
Usage:
covaccine-notifier [command]
Available Commands:
email Notify slots availability using Email
help Help about any command
telegram Notify slots availability using Telegram
Flags:
-a, --age int Search appointment for age (required)
-d, --district string Search by district name
-o, --dose int Dose preference - 1 or 2. Default: 0 (both)
-f, --fee string Fee preferences - free (or) paid. Default: No preference
-h, --help help for covaccine-notifier
-i, --interval int Interval to repeat the search. Default: (60) second
-m, --min-capacity int Filter by minimum vaccination capacity. Default: (1)
-c, --pincode string Search by pin code
-s, --state string Search by state name
-v, --vaccine string Vaccine preferences - covishield (or) covaxin. Default: No preference
Use "covaccine-notifier [command] --help" for more information about a command.
```
example
```
$ ./covaccine-notifier email --help
```
**Note:** Gmail password won't work for 2FA enabled accounts. Follow [this](https://support.google.com/accounts/answer/185833?p=InvalidSecondFactor&visit_id=637554658548216477-2576856839&rd=1) guide to generate app token password and use it with `--password` arg
## Integration with Telegram
For telegram bot integration with covaccine-notifier follow [this](./docs/telegram-integration.md).
## Integration with Mattermost
For mattermost integration refer this [document](docs/mattermost-integration.md)
## Examples
### Terminal
#### Search by State and District
```
covaccine-notifier email --state Maharashtra --district Akola --age 27 --username --password
```
#### Search by Pin Code
```
covaccine-notifier email --pincode 444002 --age 27 --username --password
```
#### Enable Telegram Notification
```
covaccine-notifier telegram --pincode 444002 --age 27 --token --username
```
#### Enable mattermost notification
```bash
covaccine-notifier mattermost --pincode 444002 --age 27 --token --username --url
```
### Docker
```
docker run --rm -ti ghcr.io/prasadg193/covaccine-notifier:v0.2.0 email --state Maharashtra --district Akola --age 27 --username --password
```
### Running on Kubernetes Cluster
If you are not willing to keep your terminal on all the time :smile:, you can also create a Pod on K8s cluster
```
kubectl run covaccine-notifier --image=ghcr.io/prasadg193/covaccine-notifier:v0.2.0 --command -- /covaccine-notifier email --state Maharashtra --district Akola --age 27 --username --password
```
## Contributing
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features