Metadata-Version: 2.1
Name: shift-tool
Version: 2.0
Summary: Keyed text encoding
Home-page: https://github.com/Ewpratten/shift
Author: Evan Pratten
Author-email: ewpratten@gmail.com
License: UNKNOWN
Description: # shift
        Keyed text encoding
        
        ## Installation
        To install this tool and library, use PIP:
        ```sh
        # Install shift
        pip3 install shift-tool
        
        # Run shift
        shift2
        ```
        
        NOTE: the executable is named `shift2` not `shift`.
        
        ## Usage
        Shift has two modes:
        ```sh
        # Encode
        shift2 /path/to/input/file your_key_here > output.shift
        
        # Decode
        shift2 -d /path/to/encoded/file your_key_here > output.txt
        ```
        
        ## Speed
        By using Python's `cProfile` tool, we can see the time required to encode and decode `example.txt`. This file contains 50 paragraphs generated by [lipsum.com](https://www.lipsum.com), using the key `ewpratten`:
        ```
        Encoding:  0.089 seconds 
        Deconding: 0.101 seconds
        ```
        
        ## Development
        ### Deploying to PIP
        To deploy shift to PIP, use:
        ```
        pip3 uninstall shift-tool
        ./deploy.sh
        pip3 install --no-cache-dir shift-tool
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Description-Content-Type: text/markdown
