Metadata-Version: 1.1
Name: zwsp-steg-py
Version: 0.2.0
Summary: Zero-Width Space Steganography, encodes/decodes hidden messages as non printable/readable characters.
Home-page: https://github.com/enodari/zwsp-steg-py
Author: Edoardo Nodari
Author-email: info@nodari.me
License: Apache 2.0
Description-Content-Type: text/markdown
Description: # zwsp-steg-py
        Zero-Width Space Steganography. Encodes and decodes hidden messages as non printable/readable characters.
        This repository is a Python porting of [zwsp-steg-js](https://github.com/offdev/zwsp-steg-js).
        All credits to [offdev](https://github.com/offdev)!
        
        ### Installation
        ```bash
        $ pip install zwsp-steg-py
        ```
        
        ### Usage Example
        ```.py
        import zwsp_steg
        
        encoded = zwsp_steg.encode('hidden message')
        decoded = zwsp_steg.decode(encoded)
        
        print(decoded)  # hidden message
        ```
        
        Note that decoding a message will ignore all non 'special' characters. That means if you hide your message within a readable string, and decode the whole string, you will only return the hidden message.
        
        ### Parameters
        You can use different sets of characters in different encoding / decoding modes.
        
        ```.py
        import zwsp_steg
        
        zwsp_steg.encode('hidden message', zwsp_steg.MODE_ZWSP)
        zwsp_steg.encode('hidden message', zwsp_steg.MODE_FULL)
        ```
        
        #### Character sets used
        - **MODE_ZWSP**: Zero-Width Space (\u200b), Zero-Width Non-Joiner (\u200c), Zero-Width Joiner (\u200d)
        - **MODE_FULL**: All MODE_ZWSP characters, Left-To-Right Mark (\u200e), Right-To-Left Mark (\u200f)
        
        ### License
        [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.6
