| Name | dsfx JSON |
| Version |
0.3
JSON |
| download |
| home_page | None |
| Summary | create installer packages |
| upload_time | 2024-04-14 09:40:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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. |
| keywords |
d33pster
pymakeself
makeself
makesfx
dsfx
pythonsfx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# dsfx
[](https://ci.appveyor.com/project/d33pster/dsfx)
[](https://codecov.io/gh/d33pster/dsfx)
[](https://github.com/d33pster/dsfx/actions/workflows/FeaturesTestCI.yml)
<p align='center'>
<a href='#Installation'>Installation</a>
|
<a href='#Usage'>Usage</a>
</p>
## NOTE: Backing up your files before using dsfx is best practice
dsfx 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
dsfx 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 dsfx
# download wheel or package from github or pypi
```
Links:
- [PYPI](https://pypi.org/project/dsfx/) Package page.
- [GitHub](https://github.com/d33pster/dsfx) Repository.
Raise Issue Here:
- [GitHub](https://github.com/d33pster/dsfx/issues) Issues.
## Usage
flow:
```console
# import as a module in python script/project
>>> from dsfx.dsfx 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 dsfx:
_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
$ dsfx -h
help:
dsfx v0.2.4
HELP TEXT
format: $ dsfx [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)
| -ne or --no-executable - Output .py file. Default: make executable file. (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/dsfx/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": "dsfx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Soumyo Deep Gupta <deep.main.ac@gmail.com>",
"keywords": "d33pster, pymakeself, makeself, makesfx, dsfx, pythonsfx",
"author": null,
"author_email": "Soumyo Deep Gupta <deep.main.ac@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/eb/fc/63a0587aacc39dc6d0d6fb882f1f80fae8883626ae42d3197a3423bc1a74/dsfx-0.3.tar.gz",
"platform": null,
"description": "# dsfx\n[](https://ci.appveyor.com/project/d33pster/dsfx)\n[](https://codecov.io/gh/d33pster/dsfx)\n[](https://github.com/d33pster/dsfx/actions/workflows/FeaturesTestCI.yml)\n\n\n\n\n\n\n\n<p align='center'>\n <a href='#Installation'>Installation</a>\n | \n <a href='#Usage'>Usage</a>\n</p>\n\n## NOTE: Backing up your files before using dsfx is best practice\n\ndsfx 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\ndsfx 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 dsfx\n\n# download wheel or package from github or pypi\n```\nLinks:\n\n- [PYPI](https://pypi.org/project/dsfx/) Package page.\n- [GitHub](https://github.com/d33pster/dsfx) Repository.\n\nRaise Issue Here:\n- [GitHub](https://github.com/d33pster/dsfx/issues) Issues.\n\n## Usage\nflow:\n```console\n# import as a module in python script/project\n\n>>> from dsfx.dsfx 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 dsfx:\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$ dsfx -h\nhelp:\n dsfx v0.2.4\n\n HELP TEXT\n\n format: $ dsfx [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 | -ne or --no-executable - Output .py file. Default: make executable file. (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/dsfx/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": "create installer packages",
"version": "0.3",
"project_urls": {
"Documentation": "https://d33pster.github.io/dsfx/",
"GitHub": "https://github.com/d33pster/dsfx",
"Issues": "https://github.com/d33pster/dsfx/issues"
},
"split_keywords": [
"d33pster",
" pymakeself",
" makeself",
" makesfx",
" dsfx",
" pythonsfx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3cfc34d4ad2563d6fa3cf808fd130e65caf4d7f2d87cadf34e45629c8df91ff",
"md5": "d407b6825aec974a4dd7289d9887a86a",
"sha256": "98536bb0922f28a49e8b5e4c140ede1fbbcf452e791621140bc761efca4fc58f"
},
"downloads": -1,
"filename": "dsfx-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d407b6825aec974a4dd7289d9887a86a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 12539,
"upload_time": "2024-04-14T09:40:50",
"upload_time_iso_8601": "2024-04-14T09:40:50.804787Z",
"url": "https://files.pythonhosted.org/packages/f3/cf/c34d4ad2563d6fa3cf808fd130e65caf4d7f2d87cadf34e45629c8df91ff/dsfx-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebfc63a0587aacc39dc6d0d6fb882f1f80fae8883626ae42d3197a3423bc1a74",
"md5": "74be96d7f889229b711323d95072b498",
"sha256": "099814acb76a03048d0c94ab298389bedc522364a8292afd0f4a954c313c015a"
},
"downloads": -1,
"filename": "dsfx-0.3.tar.gz",
"has_sig": false,
"md5_digest": "74be96d7f889229b711323d95072b498",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14447,
"upload_time": "2024-04-14T09:40:52",
"upload_time_iso_8601": "2024-04-14T09:40:52.523465Z",
"url": "https://files.pythonhosted.org/packages/eb/fc/63a0587aacc39dc6d0d6fb882f1f80fae8883626ae42d3197a3423bc1a74/dsfx-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 09:40:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "d33pster",
"github_project": "dsfx",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dsfx"
}
