warlockSFX


NamewarlockSFX JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummarywarlockSFX is a part of warlock (Data Breach protection software), and is based on pymakeself by Andrew Gillis.
upload_time2024-03-26 14:49:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2024 Soumyo Deep Gupta 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 d33pster pymakeself pymakeself alternative makesfx warlock warlocksfx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # warlockSFX

![GitHub last commit](https://img.shields.io/github/last-commit/d33pster/warlockSFX)
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/d33pster/warlockSFX)
![PyPI - Status](https://img.shields.io/pypi/status/warlockSFX)
![PyPI - Implementation](https://img.shields.io/pypi/implementation/warlockSFX)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/warlockSFX)
![PyPI - Version](https://img.shields.io/pypi/v/warlockSFX)
![GitHub License](https://img.shields.io/github/license/d33pster/warlockSFX)

<p align='center'>
    <a href='#Installation'>Installation</a>
    &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
    <a href='#Usage'>Usage</a>
</p>

warlockSFX is an upgraded version of pymakeself by Andrew Gillis, well, kind of.<br><br>
Changes:
- python >= 3.9 support
- choice of output file (OS specific executable file(with custom extension) or a .py file)
- removed encryption support.
- some features are made optional

## About
warlockSFX is a part of warlock (Data Breach Protection Software (patent-pending)). It is an upgraded version of pymakeself and works fine with recent versions of python

## Working
```console
somewhere/_setup --------------------+
                                     |
                                     |
                                     |
someplace/_content/ -----------+     |
         file 1                |     |
         file 2                |     |
         ...                   |     |
                               |     |
                               |     |
   ./package/                  |     |
          inf/                 |     |
             ...   <-----------+     |
             ...   <-----------------+
    

    +---------+                  +---------------+
./  | package | ---------------> | package.targz | ----------+
    +---------+                  +---------------+           |
                                                             |
                                                             |
                                                             |
    +-------------------------------------------------+      |
 ./ | package.py/package.<extension>(executable file) | <----+
    +-------------------------------------------------+

```

## Installation
```console
# install using pip
$ pip install warlocksfx

# download wheel or package from github or pypi
```
Links:

- [PYPI](https://pypi.org/project/warlockSFX/0.1.4/) Package page.
- [GitHub](https://github.com/d33pster/warlockSFX) Repository.

Raise Issue Here:
- [GitHub](https://github.com/d33pster/warlockSFX) Issues.

## Usage
flow:
```console
# import as a module in python script/project

>>> from warlocksfx import _makesfx

# create a class object

>>> sfxCTRL = _makesfx()

# make sfx

>>> sfxCTRL._make(Params)
```

function help:
```console
>>> help(_makesfx._make)

Help on function _make in module warlocksfx:

_make(self, content: str, outfile: str, _setup: str, _setupargs=(), sha256=False, compress='gz', quiet=False, label=None, extension='.warlock')
    Create SFX

    Args:
        content (str): input directory
        outfile (str): output executable name
        _setup (str): setup file which will be executed from the extracted content dir
        _setupargs (tuple, optional): setup file arguments if any. Defaults to ().
        sha256 (bool, optional): Enable (True), Disable (False) SHA256. Defaults to False.
        compress (str, optional): Type of compression. Defaults to 'gz'. Possible -> ['gz', 'bz2', 'xz']
        quiet (bool, optional): Do not print any messages other than errors if True. Defaults to False.
        label (_type_, optional): Text describing the package. Defaults to None.

    Return:
        Path to SFX executable
```

## Usage (Terminal)
```console
$ warlocksfx -h
help:
    warlockSFX v0.2.1

    HELP TEXT

    format: $ warlocksfx [args] -s <setup> [setup-args]

        |    -h or --help             -      show this help text. press q to exit.
        |    -v or --version          -      show version info and exit.
        |
        |    COMPULSORY ARGUMENTS
        |
        |    -i or --infile           -      input file path or relative path.
        |    -o or --outfile          -      output file name.
        |    -s or --setup            -      setup script (executable). NOTE: can be a python script with a sheba
    ng
        |    NORMAL ARGUMENTS
        |
        |    -c or --compress-method  -      set compression method. Possible values: ['gz', 'bz2', 'xz']
        |    -l or --label            -      set label text. Default: None
        |    -e or --extension        -      specify output file extension. Default: '*.warlock'
        |    -cs or --checksum        -      set checksum true or false. if not specified, it is off. (switch)
        |    -q or --quiet            -      set quiet mode on. Default: off. (switch)

    END
```

## Note to Users
I made this for my own personal use but it is not limited to that. If there is any suggestions or fixes, raise an issue [here](https://github.com/d33pster/warlockSFX/issues).

The Original pymakeself was made by Andrew Gillis (Around 10 years ago or so). As a lot of users find it hard because it is deprecated, hope this helps :)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "warlockSFX",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Soumyo Deep Gupta <deep.main.ac@gmail.com>",
    "keywords": "d33pster, pymakeself, pymakeself alternative, makesfx, warlock, warlocksfx",
    "author": null,
    "author_email": "Soumyo Deep Gupta <deep.main.ac@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/df/e0/acc54fa82d1f2381bb54a8c7b0a18cf9587963c666dc3c7588afedd2ad97/warlockSFX-0.2.1.tar.gz",
    "platform": null,
    "description": "# warlockSFX\n\n![GitHub last commit](https://img.shields.io/github/last-commit/d33pster/warlockSFX)\n![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/d33pster/warlockSFX)\n![PyPI - Status](https://img.shields.io/pypi/status/warlockSFX)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/warlockSFX)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/warlockSFX)\n![PyPI - Version](https://img.shields.io/pypi/v/warlockSFX)\n![GitHub License](https://img.shields.io/github/license/d33pster/warlockSFX)\n\n<p align='center'>\n    <a href='#Installation'>Installation</a>\n    &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;\n    <a href='#Usage'>Usage</a>\n</p>\n\nwarlockSFX is an upgraded version of pymakeself by Andrew Gillis, well, kind of.<br><br>\nChanges:\n- python >= 3.9 support\n- choice of output file (OS specific executable file(with custom extension) or a .py file)\n- removed encryption support.\n- some features are made optional\n\n## About\nwarlockSFX is a part of warlock (Data Breach Protection Software (patent-pending)). It is an upgraded version of pymakeself and works fine with recent versions of python\n\n## Working\n```console\nsomewhere/_setup --------------------+\n                                     |\n                                     |\n                                     |\nsomeplace/_content/ -----------+     |\n         file 1                |     |\n         file 2                |     |\n         ...                   |     |\n                               |     |\n                               |     |\n   ./package/                  |     |\n          inf/                 |     |\n             ...   <-----------+     |\n             ...   <-----------------+\n    \n\n    +---------+                  +---------------+\n./  | package | ---------------> | package.targz | ----------+\n    +---------+                  +---------------+           |\n                                                             |\n                                                             |\n                                                             |\n    +-------------------------------------------------+      |\n ./ | package.py/package.<extension>(executable file) | <----+\n    +-------------------------------------------------+\n\n```\n\n## Installation\n```console\n# install using pip\n$ pip install warlocksfx\n\n# download wheel or package from github or pypi\n```\nLinks:\n\n- [PYPI](https://pypi.org/project/warlockSFX/0.1.4/) Package page.\n- [GitHub](https://github.com/d33pster/warlockSFX) Repository.\n\nRaise Issue Here:\n- [GitHub](https://github.com/d33pster/warlockSFX) Issues.\n\n## Usage\nflow:\n```console\n# import as a module in python script/project\n\n>>> from warlocksfx import _makesfx\n\n# create a class object\n\n>>> sfxCTRL = _makesfx()\n\n# make sfx\n\n>>> sfxCTRL._make(Params)\n```\n\nfunction help:\n```console\n>>> help(_makesfx._make)\n\nHelp on function _make in module warlocksfx:\n\n_make(self, content: str, outfile: str, _setup: str, _setupargs=(), sha256=False, compress='gz', quiet=False, label=None, extension='.warlock')\n    Create SFX\n\n    Args:\n        content (str): input directory\n        outfile (str): output executable name\n        _setup (str): setup file which will be executed from the extracted content dir\n        _setupargs (tuple, optional): setup file arguments if any. Defaults to ().\n        sha256 (bool, optional): Enable (True), Disable (False) SHA256. Defaults to False.\n        compress (str, optional): Type of compression. Defaults to 'gz'. Possible -> ['gz', 'bz2', 'xz']\n        quiet (bool, optional): Do not print any messages other than errors if True. Defaults to False.\n        label (_type_, optional): Text describing the package. Defaults to None.\n\n    Return:\n        Path to SFX executable\n```\n\n## Usage (Terminal)\n```console\n$ warlocksfx -h\nhelp:\n    warlockSFX v0.2.1\n\n    HELP TEXT\n\n    format: $ warlocksfx [args] -s <setup> [setup-args]\n\n        |    -h or --help             -      show this help text. press q to exit.\n        |    -v or --version          -      show version info and exit.\n        |\n        |    COMPULSORY ARGUMENTS\n        |\n        |    -i or --infile           -      input file path or relative path.\n        |    -o or --outfile          -      output file name.\n        |    -s or --setup            -      setup script (executable). NOTE: can be a python script with a sheba\n    ng\n        |    NORMAL ARGUMENTS\n        |\n        |    -c or --compress-method  -      set compression method. Possible values: ['gz', 'bz2', 'xz']\n        |    -l or --label            -      set label text. Default: None\n        |    -e or --extension        -      specify output file extension. Default: '*.warlock'\n        |    -cs or --checksum        -      set checksum true or false. if not specified, it is off. (switch)\n        |    -q or --quiet            -      set quiet mode on. Default: off. (switch)\n\n    END\n```\n\n## Note to Users\nI made this for my own personal use but it is not limited to that. If there is any suggestions or fixes, raise an issue [here](https://github.com/d33pster/warlockSFX/issues).\n\nThe Original pymakeself was made by Andrew Gillis (Around 10 years ago or so). As a lot of users find it hard because it is deprecated, hope this helps :)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Soumyo Deep Gupta  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. ",
    "summary": "warlockSFX is a part of warlock (Data Breach protection software), and is based on pymakeself by Andrew Gillis.",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "http://github.com/d33pster/warlockSFX",
        "Issues": "http://github.com/d33pster/warlockSFX/issues"
    },
    "split_keywords": [
        "d33pster",
        " pymakeself",
        " pymakeself alternative",
        " makesfx",
        " warlock",
        " warlocksfx"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "09ecf63882cc1cdeff08fc8348a59d67bd6827da5a9d42a9458f45dae51c49eb",
                "md5": "4416c63de5b3351a9fdd282ff2632f4b",
                "sha256": "59d4a3774d887fb1a9be448cfccc7b679cfb8dc6a1ae21ecc563025099e7c51a"
            },
            "downloads": -1,
            "filename": "warlockSFX-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4416c63de5b3351a9fdd282ff2632f4b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 10852,
            "upload_time": "2024-03-26T14:49:45",
            "upload_time_iso_8601": "2024-03-26T14:49:45.817401Z",
            "url": "https://files.pythonhosted.org/packages/09/ec/f63882cc1cdeff08fc8348a59d67bd6827da5a9d42a9458f45dae51c49eb/warlockSFX-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dfe0acc54fa82d1f2381bb54a8c7b0a18cf9587963c666dc3c7588afedd2ad97",
                "md5": "b3561be116f16ffea78ae71417b33414",
                "sha256": "d243a74b89b2eb5223f850c80badcc6c1ff736b354a5292ef9f5e9dcb77cd071"
            },
            "downloads": -1,
            "filename": "warlockSFX-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b3561be116f16ffea78ae71417b33414",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 9699,
            "upload_time": "2024-03-26T14:49:47",
            "upload_time_iso_8601": "2024-03-26T14:49:47.526997Z",
            "url": "https://files.pythonhosted.org/packages/df/e0/acc54fa82d1f2381bb54a8c7b0a18cf9587963c666dc3c7588afedd2ad97/warlockSFX-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-26 14:49:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "d33pster",
    "github_project": "warlockSFX",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "warlocksfx"
}
        
Elapsed time: 3.22507s