ImageScript


NameImageScript JSON
Version 1.1.0 PyPI version JSON
download
home_pageNone
SummaryA python library and command line tool to convert text to images and back.
upload_time2024-11-10 16:44:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseCopyright 2024 Nikolas Teuschl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords steganography image security storage encryption experimental
VCS
bugtrack_url
requirements build certifi cffi cfgv charset-normalizer cryptography distlib docutils filelock identify idna ImageScript importlib_metadata iniconfig jaraco.classes jaraco.context jaraco.functools jeepney Jinja2 keyring markdown-it-py MarkupSafe mdurl more-itertools nh3 nodeenv numpy packaging pdoc pillow pkginfo platformdirs pluggy pre_commit pycparser pycryptodome Pygments pyproject_hooks pyright pytest PyYAML readme_renderer requests requests-toolbelt rfc3986 rich ruff SecretStorage setuptools twine typing_extensions urllib3 virtualenv wheel zipp
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ImageScript

![PyPI - Version](https://img.shields.io/pypi/v/ImageScript)

A python library and command line tool to convert text to images and back. Includes optional en-/decryption and steganography.

## Disclaimer

This is a hobby project and not meant for production use. Most of it was also created in one day, so there might be some bugs.

## Installation

Simply install using pip:

```bash
pip install ImageScript
```

You can also build it from scratch from within the downloaded repository using build:

```bash
pip install --upgrade build
python -m build
```

## Usage

### Command Line

You can simply use the command line tool to convert text to images and back.
Each sub-command has additional options.

```bash
imagescript [-h] [-V] {to_image,to_text,execute,pack,unpack} ...

A command line tool to convert text into images and back.
Also supports executing images as scripts and basic Steganography with pack and unpack.

options:
  -h, --help            show this help message and exit
  -V, --version         Print the version number and exit.

command:
    {to_image,to_text,execute,pack,unpack}
                        The command to execute.
    to_image            Convert text to an image.
    to_text             Convert image to a text.
    execute             Execute an image file containing a python script. Be careful when using this command.
                        Do not execute scripts from unknown sources!
    pack                Hide a text file in an existing image. (Steganography)
    unpack              Extract text from an image file with hidden data. (Steganography)
```

**A few examples:**

Convert text to an image and also encrypt it using a password prompt:
```bash
imagescript to_image -o output.webp -P input.txt
```

Convert the previously converted image back to a script file using a directly supplied password:
```bash
imagescript to_text -o input.out.txt --password mysecret output.webp
```

Use steganography to hide a text file in an image:
```bash
imagescript pack -o output.webp my_data.txt cover_image.webp
```

## Change Log

- Version 1.1.0 - 10.11.2024
  Added more secure way to supply passwords
- Version 1.0.0 - 10.11.2024
  Initial release

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ImageScript",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "steganography, image, security, storage, encryption, experimental",
    "author": null,
    "author_email": "Nikolas Teuschl <niklas.teuschl@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/b2/ff/d9440a947aa0ecfd3a6227fde8652a651b51e87fe545ee63afa649d3f24b/imagescript-1.1.0.tar.gz",
    "platform": null,
    "description": "# ImageScript\n\n![PyPI - Version](https://img.shields.io/pypi/v/ImageScript)\n\nA python library and command line tool to convert text to images and back. Includes optional en-/decryption and steganography.\n\n## Disclaimer\n\nThis is a hobby project and not meant for production use. Most of it was also created in one day, so there might be some bugs.\n\n## Installation\n\nSimply install using pip:\n\n```bash\npip install ImageScript\n```\n\nYou can also build it from scratch from within the downloaded repository using build:\n\n```bash\npip install --upgrade build\npython -m build\n```\n\n## Usage\n\n### Command Line\n\nYou can simply use the command line tool to convert text to images and back.\nEach sub-command has additional options.\n\n```bash\nimagescript [-h] [-V] {to_image,to_text,execute,pack,unpack} ...\n\nA command line tool to convert text into images and back.\nAlso supports executing images as scripts and basic Steganography with pack and unpack.\n\noptions:\n  -h, --help            show this help message and exit\n  -V, --version         Print the version number and exit.\n\ncommand:\n    {to_image,to_text,execute,pack,unpack}\n                        The command to execute.\n    to_image            Convert text to an image.\n    to_text             Convert image to a text.\n    execute             Execute an image file containing a python script. Be careful when using this command.\n                        Do not execute scripts from unknown sources!\n    pack                Hide a text file in an existing image. (Steganography)\n    unpack              Extract text from an image file with hidden data. (Steganography)\n```\n\n**A few examples:**\n\nConvert text to an image and also encrypt it using a password prompt:\n```bash\nimagescript to_image -o output.webp -P input.txt\n```\n\nConvert the previously converted image back to a script file using a directly supplied password:\n```bash\nimagescript to_text -o input.out.txt --password mysecret output.webp\n```\n\nUse steganography to hide a text file in an image:\n```bash\nimagescript pack -o output.webp my_data.txt cover_image.webp\n```\n\n## Change Log\n\n- Version 1.1.0 - 10.11.2024\n  Added more secure way to supply passwords\n- Version 1.0.0 - 10.11.2024\n  Initial release\n",
    "bugtrack_url": null,
    "license": "Copyright 2024 Nikolas Teuschl  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A python library and command line tool to convert text to images and back.",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://github.com/NeoSecundus/ImageScript",
        "Source": "https://github.com/NeoSecundus/ImageScript"
    },
    "split_keywords": [
        "steganography",
        " image",
        " security",
        " storage",
        " encryption",
        " experimental"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f6bc45fac92a9c43bc89ac0d630eba467b1607f998128b71c3a4a60c76cca98a",
                "md5": "9ce719093029fb02ff455f11cbf89dd6",
                "sha256": "9d6a1b0ed1c5c5a2358e2270d2387b987bc98e9a681a5a628e3d9ec920817566"
            },
            "downloads": -1,
            "filename": "ImageScript-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ce719093029fb02ff455f11cbf89dd6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 9092,
            "upload_time": "2024-11-10T16:44:11",
            "upload_time_iso_8601": "2024-11-10T16:44:11.811145Z",
            "url": "https://files.pythonhosted.org/packages/f6/bc/45fac92a9c43bc89ac0d630eba467b1607f998128b71c3a4a60c76cca98a/ImageScript-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b2ffd9440a947aa0ecfd3a6227fde8652a651b51e87fe545ee63afa649d3f24b",
                "md5": "f5a32ab1740ae4408f6a5991d2adc51c",
                "sha256": "d45dea7108e3f8e8906c4c80412bd2447c4f005fb559d7f5f2a8b827709c6a0a"
            },
            "downloads": -1,
            "filename": "imagescript-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f5a32ab1740ae4408f6a5991d2adc51c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 8129,
            "upload_time": "2024-11-10T16:44:12",
            "upload_time_iso_8601": "2024-11-10T16:44:12.999805Z",
            "url": "https://files.pythonhosted.org/packages/b2/ff/d9440a947aa0ecfd3a6227fde8652a651b51e87fe545ee63afa649d3f24b/imagescript-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-10 16:44:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NeoSecundus",
    "github_project": "ImageScript",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "build",
            "specs": [
                [
                    "==",
                    "1.2.2.post1"
                ]
            ]
        },
        {
            "name": "certifi",
            "specs": [
                [
                    "==",
                    "2024.8.30"
                ]
            ]
        },
        {
            "name": "cffi",
            "specs": [
                [
                    "==",
                    "1.17.1"
                ]
            ]
        },
        {
            "name": "cfgv",
            "specs": [
                [
                    "==",
                    "3.4.0"
                ]
            ]
        },
        {
            "name": "charset-normalizer",
            "specs": [
                [
                    "==",
                    "3.4.0"
                ]
            ]
        },
        {
            "name": "cryptography",
            "specs": [
                [
                    "==",
                    "43.0.3"
                ]
            ]
        },
        {
            "name": "distlib",
            "specs": [
                [
                    "==",
                    "0.3.9"
                ]
            ]
        },
        {
            "name": "docutils",
            "specs": [
                [
                    "==",
                    "0.21.2"
                ]
            ]
        },
        {
            "name": "filelock",
            "specs": [
                [
                    "==",
                    "3.16.1"
                ]
            ]
        },
        {
            "name": "identify",
            "specs": [
                [
                    "==",
                    "2.6.1"
                ]
            ]
        },
        {
            "name": "idna",
            "specs": [
                [
                    "==",
                    "3.10"
                ]
            ]
        },
        {
            "name": "ImageScript",
            "specs": [
                [
                    "==",
                    "0.1.0"
                ]
            ]
        },
        {
            "name": "importlib_metadata",
            "specs": [
                [
                    "==",
                    "8.5.0"
                ]
            ]
        },
        {
            "name": "iniconfig",
            "specs": [
                [
                    "==",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "jaraco.classes",
            "specs": [
                [
                    "==",
                    "3.4.0"
                ]
            ]
        },
        {
            "name": "jaraco.context",
            "specs": [
                [
                    "==",
                    "6.0.1"
                ]
            ]
        },
        {
            "name": "jaraco.functools",
            "specs": [
                [
                    "==",
                    "4.1.0"
                ]
            ]
        },
        {
            "name": "jeepney",
            "specs": [
                [
                    "==",
                    "0.8.0"
                ]
            ]
        },
        {
            "name": "Jinja2",
            "specs": [
                [
                    "==",
                    "3.1.4"
                ]
            ]
        },
        {
            "name": "keyring",
            "specs": [
                [
                    "==",
                    "25.5.0"
                ]
            ]
        },
        {
            "name": "markdown-it-py",
            "specs": [
                [
                    "==",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "MarkupSafe",
            "specs": [
                [
                    "==",
                    "3.0.2"
                ]
            ]
        },
        {
            "name": "mdurl",
            "specs": [
                [
                    "==",
                    "0.1.2"
                ]
            ]
        },
        {
            "name": "more-itertools",
            "specs": [
                [
                    "==",
                    "10.5.0"
                ]
            ]
        },
        {
            "name": "nh3",
            "specs": [
                [
                    "==",
                    "0.2.18"
                ]
            ]
        },
        {
            "name": "nodeenv",
            "specs": [
                [
                    "==",
                    "1.9.1"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "==",
                    "2.1.3"
                ]
            ]
        },
        {
            "name": "packaging",
            "specs": [
                [
                    "==",
                    "24.2"
                ]
            ]
        },
        {
            "name": "pdoc",
            "specs": [
                [
                    "==",
                    "15.0.0"
                ]
            ]
        },
        {
            "name": "pillow",
            "specs": [
                [
                    "==",
                    "11.0.0"
                ]
            ]
        },
        {
            "name": "pkginfo",
            "specs": [
                [
                    "==",
                    "1.10.0"
                ]
            ]
        },
        {
            "name": "platformdirs",
            "specs": [
                [
                    "==",
                    "4.3.6"
                ]
            ]
        },
        {
            "name": "pluggy",
            "specs": [
                [
                    "==",
                    "1.5.0"
                ]
            ]
        },
        {
            "name": "pre_commit",
            "specs": [
                [
                    "==",
                    "4.0.1"
                ]
            ]
        },
        {
            "name": "pycparser",
            "specs": [
                [
                    "==",
                    "2.22"
                ]
            ]
        },
        {
            "name": "pycryptodome",
            "specs": [
                [
                    "==",
                    "3.21.0"
                ]
            ]
        },
        {
            "name": "Pygments",
            "specs": [
                [
                    "==",
                    "2.18.0"
                ]
            ]
        },
        {
            "name": "pyproject_hooks",
            "specs": [
                [
                    "==",
                    "1.2.0"
                ]
            ]
        },
        {
            "name": "pyright",
            "specs": [
                [
                    "==",
                    "1.1.388"
                ]
            ]
        },
        {
            "name": "pytest",
            "specs": [
                [
                    "==",
                    "8.3.3"
                ]
            ]
        },
        {
            "name": "PyYAML",
            "specs": [
                [
                    "==",
                    "6.0.2"
                ]
            ]
        },
        {
            "name": "readme_renderer",
            "specs": [
                [
                    "==",
                    "44.0"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.32.3"
                ]
            ]
        },
        {
            "name": "requests-toolbelt",
            "specs": [
                [
                    "==",
                    "1.0.0"
                ]
            ]
        },
        {
            "name": "rfc3986",
            "specs": [
                [
                    "==",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "13.9.4"
                ]
            ]
        },
        {
            "name": "ruff",
            "specs": [
                [
                    "==",
                    "0.7.3"
                ]
            ]
        },
        {
            "name": "SecretStorage",
            "specs": [
                [
                    "==",
                    "3.3.3"
                ]
            ]
        },
        {
            "name": "setuptools",
            "specs": [
                [
                    "==",
                    "75.1.0"
                ]
            ]
        },
        {
            "name": "twine",
            "specs": [
                [
                    "==",
                    "5.1.1"
                ]
            ]
        },
        {
            "name": "typing_extensions",
            "specs": [
                [
                    "==",
                    "4.12.2"
                ]
            ]
        },
        {
            "name": "urllib3",
            "specs": [
                [
                    "==",
                    "2.2.3"
                ]
            ]
        },
        {
            "name": "virtualenv",
            "specs": [
                [
                    "==",
                    "20.27.1"
                ]
            ]
        },
        {
            "name": "wheel",
            "specs": [
                [
                    "==",
                    "0.44.0"
                ]
            ]
        },
        {
            "name": "zipp",
            "specs": [
                [
                    "==",
                    "3.20.2"
                ]
            ]
        }
    ],
    "lcname": "imagescript"
}
        
Elapsed time: 0.88205s