Metadata-Version: 2.1
Name: wipeit
Version: 0.1.5
Summary: A small CLI to purge your Reddit history.
Home-page: https://github.com/amickael/wipeit
Author: Andrew Mickael
Author-email: andrew.mickael@gmail.com
License: UNKNOWN
Description: # Wipeit!
        A small CLI to purge your Reddit history.
        
        [![Release](https://github.com/amickael/wipeit/actions/workflows/python-publish.yml/badge.svg)](https://github.com/amickael/wipeit/actions/workflows/python-publish.yml)
        [![PyPI](https://img.shields.io/pypi/v/wipeit?color=blue)](https://pypi.org/project/wipeit/)
        [![Code style](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
        
        
        ![wipeit](https://repository-images.githubusercontent.com/365859955/17783580-b1d0-11eb-9738-6d2bc92644e6)
        
        ## 👶 Dependencies
        * [Python 3.6 or higher](https://www.python.org/downloads/)
        
        ## 🛠️ Installation
        Install from PyPI using `pip`, you may need to use `pip3` depending on your installation:
        ```sh
        pip install wipeit
        ```
        
        ## 🚀 Usage
        **wipeit** is a command-line program to purge your Reddit history. It requires a Python interpreter version 3.6+.
        
        To authenticate without wiping history you can use the `login` command, a browser window will open prompting you to login to Reddit:
        ```shell
        wipeit login
        ```
        ---
        To wipe your Reddit history you can use the `wipe` command. The following command will clear the last 30 days of comment and submission history, and will overwrite them with random text before deletion:
        ```shell
        wipeit wipe -d 30 -sco
        ```
        > Note: A browser window will open to request access to your account if you have not previously authenticated.
        ---
        To remove Reddit credentials from your computer you can use the `logout` command:
        ```shell
        wipeit logout
        ```
        
        
        ## ⚙️ Options
        ### `wipeit`
        ```
        Usage: wipeit [OPTIONS] COMMAND [ARGS]...
        
        Options:
          --version  Show the version and exit.
          --help     Show help message and exit.
        
        Commands:
          login   Authorize wipeit with a Reddit account, will open a browser
                  window...
        
          logout  Remove Reddit credentials from wipeit, you will be prompted to...
          wipe    Wipe your Reddit history.
        ```
        
        ### `wipeit wipe`
        ```
        Usage: wipeit wipe [OPTIONS]
        
          Wipe your Reddit history.
        
        Options:
          -d, --days INTEGER RANGE  Number of days worth of content to delete.
                                    Defaults to 365.
        
          -f, --from-date TEXT      Date relative to --days, in ISO format (YYYY-MM-
                                    DD). Defaults to today.
        
          -c, --comments            Delete comments.
          -s, --submissions         Delete submissions.
          -o, --overwrite           Overwrite content with random text before
                                    deletion.
        
          --help                    Show help message and exit.
        ```
        
        ### `wipeit login`
        ```
        Usage: wipeit login [OPTIONS]
        
          Authorize wipeit with a Reddit account, will open a browser window to
          authenticate.
        
        Options:
          --help  Show help message and exit.
        ```
        
        ### `wipeit logout`
        ```
        Usage: wipeit logout [OPTIONS]
        
          Remove Reddit credentials from wipeit, you will be prompted to login the
          next time the program is run.
        
        Options:
          --help  Show help message and exit.
        ```
        
        
        ## ⚖️ License
        [MIT © 2021 Andrew Mickael](https://github.com/amickael/wipeit/blob/master/LICENSE)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
