An open API service indexing awesome lists of open source software.

https://github.com/roerohan/pls-give-vaccine

Pls give vaccine.
https://github.com/roerohan/pls-give-vaccine

Last synced: 10 months ago
JSON representation

Pls give vaccine.

Awesome Lists containing this project

README

          

[![Issues][issues-shield]][issues-url]

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)




Pls Give Vaccine


A script to spam yourself with vaccine notifications.


Explore the docs ยป




View Demo
ยท
Report Bug
ยท
Request Feature

## Table of Contents

* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contributors](#contributors-)

## About The Project

Spam yourself with messages and calls (potentially) upon availability of vaccines (in India).

### Built With

* [Python](https://www.python.org/)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

- python

### Installation

1. Clone the Repo
```sh
git clone https://github.com/roerohan/pls-give-vaccine.git
cd pls-give-vaccine
```

## Usage

To start the script, run the following command:

- Using district ID
```sh
python src/main.py --district --telegram --dose
```

- Using pincode
```sh
python src/main.py --pincode --telegram --dose
```

To get a list of possible options, run `-h`.

```
$ python src/main.py -h

To receive calls, visit https://api2.callmebot.com/txt/login.php and authenticate using telegram.

usage: main.py [-h] [--district district] [--pincode pincode] --telegram telegram [--dose dose]

Command Line Arguments for Pls Give Vaccine

optional arguments:
-h, --help show this help message and exit
--district district District ID
--pincode pincode Pincode
--telegram telegram Telegram username
--dose dose Dose Number (1 or 2)
```

## Roadmap

See the [open issues](https://github.com/roerohan/pls-give-vaccine/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.

## License

Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.

[roerohan-url]: https://roerohan.tech
[issues-shield]: https://img.shields.io/github/issues/roerohan/pls-give-vaccine.svg?style=flat-square
[issues-url]: https://github.com/roerohan/pls-give-vaccine/issues

## Contributors โœจ

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Siddharth Singha Roy

๐Ÿ“– ๐Ÿ’ป

Rohan Mukherjee

๐Ÿ“– ๐Ÿ’ป

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!