whatsapp-web-cli 0.0.0
WhatsApp Web command line interface tool
Requires Python: >=3.6
Keywords: WhatsApp,WhatsAppWeb,Selenium,Bot,Webdriver

<!--
SPDX-FileCopyrightText: 2020 Pablo Jiménez Pascual <pablo.jimpas@pm.me>

SPDX-License-Identifier: GFDL-1.3-only
-->

# WhatsApp Web CLI

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](./.github/CONTRIBUTING.md)

## Introduction  

The initial goal of this project was playing around with [Python](https://www.python.org/)
and [Selenium WebDriver](https://seleniumhq.github.io/selenium/docs/api/py/)
but over time it has become useful and could be a great tool for some use cases,
so I have released it as free software expecting help from contributors to learn
more and improve it together.

## Table of contents

- [WhatsAppCLI](#whatsapp-cli-tool)
  - [Introduction](#introduction)
  - [Table of contents](#table-of-contents)
  - [Installation](#installation)
    - [Requirements](#requirements)
    - [Run instructions](#run-instructions)
    - [Limitations](#limitations)
  - [Bugs and feature requests](#bugs-and-feature-requests)
  - [Contributing](#contributing)
  - [Community](#community)
  - [Support](#support)
  - [Legal](#legal)
  - [License](#license)

## Installation  

### Requirements  

- Internet connection in the system.
- A copy of Firefox  with `geckodriver` or Chromium/Chrome with `chromedriver`
has to be installed in the system.
- A copy of `Python 3.x` and `pip` has to be installed in the system.
- Python packages specified in `requirements.txt`

### Run instructions

1. First, check that you have the [necessary tools](#requirements) installed.
2. Open a terminal and clone the repository
`git clone https://github.com/pablojimpas/whatsapp-web-cli`.
3. Execute `python3 -m venv .venv` to create your local virtual
environment (recommended/optional)
4. Run `python3 -m pip install -r requirements.txt`

### Limitations

- A phone with WhatsApp has to be on, connected to the Internet and
manually scan the QR Code from Whatsapp Web.

## Bugs and feature requests

Have a bug or a feature request? Please first read the
[issue guidelines](./.github/CONTRIBUTING.md#using-the-issue-tracker) and
search for existing and closed issues. If your problem or idea is not
addressed yet, please [open a new issue](https://github.com/pablojimpas/whatsapp-web-cli/issues/new).

## Contributing

Do you want to contribute? Here are our
[contribution guidelines](./.github/CONTRIBUTING.md)  

## Community  

Check out our [code of conduct](./.github/CODE_OF_CONDUCT.md)  
Get updates on project's development and chat with the project
maintainers and community members (eventually).

- Follow [@pablojimpas on Twitter](https://twitter.com/pablojimpas) for
updates.
- Chat with [@pablojimpas on Telegram](https://t.me/pablojimpas) for help
or ideas.

## Support

If you found this repository useful, like the program or want to support
the development you can do some of the following things:

- ⭐ Star the repo in GitHub ![Stars](https://img.shields.io/github/stars/pablojimpas/whatsapp-web-cli?style=social)
- 🚀 Share with your friends [![Tweet](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fintent%2Ftweet%3Furl%3Dhttps%253A%252F%252Fgithub.com%252Fpablojimpas%252Fwhatsapp-web-cli%26text%3DCheck%2520out%2520this%2520project%2520in%2520GitHub%2520made%2520by%2520%40pablojimpas%26hashtags%3DWhatsApp%252CWhatsAppWeb%252CPython%252CSelenium)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fpablojimpas%2Fwhatsapp-web-cli&text=Check%20out%20this%20project%20in%20GitHub%20made%20by%20@pablojimpas&hashtags=WhatsApp%2CWhatsAppWeb%2CPython%2CSelenium)
- 🐛 [Open issues](https://github.com/pablojimpas/whatsapp-web-cli/issues/new/choose) with problems or ideas 
- 💻 Code and test open issues [![Issues](https://img.shields.io/github/issues/pablojimpas/whatsapp-web-cli)](https://github.com/pablojimpas/whatsapp-web-cli/issues)
- 📝 Write and improve [documentation](./docs)
- 🕵 Review pull-requests or audit the repo [![PullRequests](https://img.shields.io/github/issues-pr/pablojimpas/whatsapp-web-cli)](https://github.com/pablojimpas/whatsapp-web-cli/pulls)
- Contact with the maintainer for more ways to help

## Legal

This code is in no way affiliated with, authorized, maintained, sponsored
or endorsed by WhatsApp Inc. or any of its affiliates or subsidiaries.
This is an independent and unofficial software. Use at your own risk.

## License

This software is licensed under the General Public License version 3
([GPLv3](./COPYING)) or (at your option) any later version.

![gplv3-logo](./docs/imgs/gplv3-logo.png)

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Copyright (C) 2020, Pablo Jiménez Pascual, <pablo.jimpas@pm.me> &
[contributors](https://github.com/pablojimpas/whatsapp-web-cli/graphs/contributors)