Metadata-Version: 2.1
Name: snapspam
Version: 0.1.1
Summary: Spam sendit or LMK messages.
Home-page: https://github.com/MysteryBlokHed/snapspam
Author: Adam Thompson-Sharpe
Author-email: adamthompsonsharpe@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# snapspam [![Docs Badge]](https://snapspam.readthedocs.io/en/stable/) [![Python Badge]](https://pypi.org/project/snapspam/)

Spam sendit or LMK messages.

## Installation

You can use snapspam without installing it.
If you want to use it from a command line anywhere on your computer,
then you can run:

```sh
python -m pip install snapspam
```

to install from PyPI, or:

```sh
python setup.py install
```

To install from a cloned/downloaded repository.
This will let you run snapspam anywhere.

If you don't want to install snapspam,
you can just install the requirements with:

```sh
python -m pip install -r requirements.txt
```

## Use

To get help from the CLI, run:

```sh
python -m snapspam --help
```

or

```sh
python snapspam.py --help
```

Some information about how to use the app will be returned.

To get help for a specific target app (eg. sendit), run:

```sh
python -m snapspam sendit --help
```

or

```sh
python snapspam.py sendit --help
```

Here's an example usage of the app to spam a sendit sticker:

```sh
python snapspam.py sendit cd06ec9a-2879-1afa-5108-fed08b1ecaa0 'Spammed'
```

The ID can also be replaced by the full URL, like this:

```sh
python -m snapspam sendit https://web.getsendit.com/s/cd06ec9a-2879-1afa-5108-fed08b1ecaa0 'Spammed'
```

## Documentation

Documentation of the CLI is contained in the help menu.
Library documentation is hosted on [Read the Docs].

## License

snapspam is licensed under the GNU General Public License, Version 3.0
([LICENSE](LICENSE) or <https://www.gnu.org/licenses/gpl-3.0.en.html>).

[docs badge]: https://readthedocs.org/projects/snapspam/badge/?version=latest
[python badge]: https://img.shields.io/pypi/pyversions/snapspam
[read the docs]: https://snapspam.readthedocs.io/en/stable/


