| Name | scriptgenpy JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | ScriptGenPy is a script generator tool that simplifies the process of running scripts in any language. |
| upload_time | 2023-05-01 07:32:31 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Abhishek Kumar 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 |
cli
scriptgen
bash
powershell
bat
windows
macos
linux
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# scriptgen_py
_ScriptGenPy_ is a command-line based script generator tool that simplifies the process of running scripts in any language.
## Introduction
When a script is executed using an interpreter, the command line statement can become quite long as it includes the interpreter path, script path, and all required arguments. _ScriptGenPy_ addresses this issue by consolidating the interpreter and script paths into a short command that can be easily accessed from anywhere in the system. This means that when calling the script via command, only the arguments need to be passed.
_ScriptGenPy_ generates commands for all operating systems. For Windows, it generates batch and PowerShell scripts. For macOS, it generates Shell scripts and PowerShell scripts which can be used if PowerShell is installed. For Linux, it generates Shell scripts. This makes it easy to run scripts on any platform without having to manually create the appropriate command.
### Working
Here's a Python script that takes two positional arguments: `interpreter` and `script_path`. It also has a `-v`/`--version` option to show the version information. You can run it with `python scriptgen.py <interpreter> <script_path>`.
## Build
To setup _ScriptGenPy_, you need to clone the repository from GitHub.
```sh
git clone https://github.com/isurfer21/scriptgen_py.git
```
After running these commands, you should have a local copy of _ScriptGenPy_ that is ready to use.
To use _ScriptGenPy_, navigate to the project directory and run the appropriate command.
```sh
cd scriptgen_py
python src/scriptgen.py -h
```
If it displays the help menu, the script is working!
## Usage
_ScriptGenPy_ is a command-line tool for creating script files. To use _ScriptGenPy_, you need to specify the interpreter to use and the path to the script.
```sh
scriptgenpy [interpreter] [script_path]
```
For example, to create a Python script at `/path/to/script.py`, you would run the following command:
```sh
scriptgenpy python /path/to/script.py
```
ScriptGen also supports several options:
- `-h`, `--help`: Show the help message and exit.
- `-v`, `--version`: Show the program's version number and exit.
For example, to show the version number of ScriptGen, you would run the following command:
```sh
scriptgenpy -v
```
This would output the version number of ScriptGen, which is currently `1.0.0`.
### Examples
Here are some additional examples of how to use _ScriptGenPy_:
- To create a Bash script at `/path/to/script.sh`, you would run the following command:
```sh
scriptgenpy bash /path/to/script.sh
```
- To create a Ruby script at `/path/to/script.rb`, you would run the following command:
```sh
scriptgenpy ruby /path/to/script.rb
```
- To create a Perl script at `/path/to/script.pl`, you would run the following command:
```sh
scriptgenpy perl /path/to/script.pl
```
## Publish
Here is the process to make the app ready for distribution.
### Generating distribution archives
To generate distribution packages for the package. Make sure you have the latest version of PyPA’s build installed:
```sh
python3 -m pip install --upgrade build
```
Now run this command from the same directory where `pyproject.toml` is located:
```sh
python3 -m build
```
### Uploading the distribution archives to Test PyPi
Finally, it’s time to upload your package to the Python Package Index!
Ensure to have an independent account on both platforms:
- [Test PyPI](https://test.pypi.org/)
- [PyPI](https://pypi.org/)
After that, you can use twine to upload the distribution packages. You’ll need to install Twine:
```sh
python3 -m pip install --upgrade twine
```
Once installed, run Twine to upload all of the archives under dist:
```sh
python3 -m twine upload --repository testpypi dist/*
```
You will be prompted for a _username_ and _password_. For the _username_, use `__token__`. For the _password_, use the token value, including the `pypi-` prefix.
### Installing the uploaded package from Test PyPi
You can use [pip](https://pip.pypa.io/en/stable/installation/) to install your package.
```sh
pip install -i https://test.pypi.org/simple/ scriptgenpy
```
### Uploading the package to PyPI
Similar to Test PyPI, uploading to PyPI. Put this command into action:
```sh
python -m twine upload dist/*
```
Upon successful upload, your package will be visible on the PyPI website. You may discover the uploaded package by searching the 'scriptgenpy' at PyPI.
### Installing the package from PyPi
Now that the app is public, anyone may download it and install it by using the following command.
```sh
pip install scriptgenpy
```
Raw data
{
"_id": null,
"home_page": "",
"name": "scriptgenpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Abhishek Kumar <akbittu@gmail.com>",
"keywords": "cli,scriptgen,bash,powershell,bat,windows,macos,linux",
"author": "",
"author_email": "Abhishek Kumar <akbittu@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/24/61/7edd7b3aa2d03dd7e9155545a328d067a53e4900bd9dd0652f4af8edee45/scriptgenpy-1.0.0.tar.gz",
"platform": null,
"description": "# scriptgen_py\r\n\r\n_ScriptGenPy_ is a command-line based script generator tool that simplifies the process of running scripts in any language.\r\n\r\n## Introduction\r\n\r\nWhen a script is executed using an interpreter, the command line statement can become quite long as it includes the interpreter path, script path, and all required arguments. _ScriptGenPy_ addresses this issue by consolidating the interpreter and script paths into a short command that can be easily accessed from anywhere in the system. This means that when calling the script via command, only the arguments need to be passed.\r\n\r\n_ScriptGenPy_ generates commands for all operating systems. For Windows, it generates batch and PowerShell scripts. For macOS, it generates Shell scripts and PowerShell scripts which can be used if PowerShell is installed. For Linux, it generates Shell scripts. This makes it easy to run scripts on any platform without having to manually create the appropriate command.\r\n\r\n### Working\r\n\r\nHere's a Python script that takes two positional arguments: `interpreter` and `script_path`. It also has a `-v`/`--version` option to show the version information. You can run it with `python scriptgen.py <interpreter> <script_path>`.\r\n\r\n## Build\r\n\r\nTo setup _ScriptGenPy_, you need to clone the repository from GitHub.\r\n\r\n```sh\r\ngit clone https://github.com/isurfer21/scriptgen_py.git\r\n```\r\n\r\nAfter running these commands, you should have a local copy of _ScriptGenPy_ that is ready to use.\r\n\r\nTo use _ScriptGenPy_, navigate to the project directory and run the appropriate command.\r\n\r\n```sh\r\ncd scriptgen_py\r\npython src/scriptgen.py -h\r\n```\r\n\r\nIf it displays the help menu, the script is working!\r\n\r\n## Usage\r\n\r\n_ScriptGenPy_ is a command-line tool for creating script files. To use _ScriptGenPy_, you need to specify the interpreter to use and the path to the script.\r\n\r\n```sh\r\nscriptgenpy [interpreter] [script_path]\r\n```\r\n\r\nFor example, to create a Python script at `/path/to/script.py`, you would run the following command:\r\n\r\n```sh\r\nscriptgenpy python /path/to/script.py\r\n```\r\n\r\nScriptGen also supports several options:\r\n\r\n- `-h`, `--help`: Show the help message and exit.\r\n- `-v`, `--version`: Show the program's version number and exit.\r\n\r\nFor example, to show the version number of ScriptGen, you would run the following command:\r\n\r\n```sh\r\nscriptgenpy -v\r\n```\r\n\r\nThis would output the version number of ScriptGen, which is currently `1.0.0`.\r\n\r\n### Examples\r\n\r\nHere are some additional examples of how to use _ScriptGenPy_:\r\n\r\n- To create a Bash script at `/path/to/script.sh`, you would run the following command:\r\n\r\n```sh\r\nscriptgenpy bash /path/to/script.sh\r\n```\r\n\r\n- To create a Ruby script at `/path/to/script.rb`, you would run the following command:\r\n\r\n```sh\r\nscriptgenpy ruby /path/to/script.rb\r\n```\r\n\r\n- To create a Perl script at `/path/to/script.pl`, you would run the following command:\r\n\r\n```sh\r\nscriptgenpy perl /path/to/script.pl\r\n```\r\n\r\n## Publish\r\n\r\nHere is the process to make the app ready for distribution.\r\n\r\n### Generating distribution archives\r\n\r\nTo generate distribution packages for the package. Make sure you have the latest version of PyPA\u2019s build installed:\r\n\r\n```sh\r\npython3 -m pip install --upgrade build\r\n```\r\n\r\nNow run this command from the same directory where `pyproject.toml` is located:\r\n\r\n```sh\r\npython3 -m build\r\n```\r\n\r\n### Uploading the distribution archives to Test PyPi\r\n\r\nFinally, it\u2019s time to upload your package to the Python Package Index!\r\n\r\nEnsure to have an independent account on both platforms:\r\n\r\n- [Test PyPI](https://test.pypi.org/)\r\n- [PyPI](https://pypi.org/)\r\n\r\nAfter that, you can use twine to upload the distribution packages. You\u2019ll need to install Twine:\r\n\r\n```sh\r\npython3 -m pip install --upgrade twine\r\n```\r\n\r\nOnce installed, run Twine to upload all of the archives under dist:\r\n\r\n```sh\r\npython3 -m twine upload --repository testpypi dist/*\r\n```\r\n\r\nYou will be prompted for a _username_ and _password_. For the _username_, use `__token__`. For the _password_, use the token value, including the `pypi-` prefix.\r\n\r\n### Installing the uploaded package from Test PyPi\r\n\r\nYou can use [pip](https://pip.pypa.io/en/stable/installation/) to install your package.\r\n\r\n```sh\r\npip install -i https://test.pypi.org/simple/ scriptgenpy\r\n```\r\n\r\n### Uploading the package to PyPI\r\n\r\nSimilar to Test PyPI, uploading to PyPI. Put this command into action:\r\n\r\n```sh\r\npython -m twine upload dist/*\r\n```\r\n\r\nUpon successful upload, your package will be visible on the PyPI website. You may discover the uploaded package by searching the 'scriptgenpy' at PyPI.\r\n\r\n### Installing the package from PyPi\r\n\r\nNow that the app is public, anyone may download it and install it by using the following command.\r\n\r\n```sh\r\npip install scriptgenpy\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Abhishek Kumar 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": "ScriptGenPy is a script generator tool that simplifies the process of running scripts in any language.",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/isurfer21/scriptgen_py/issues",
"Funding": "https://donate.pypi.org",
"Homepage": "https://github.com/isurfer21/scriptgen_py",
"Say Thanks!": "https://saythanks.io/to/isurfer21",
"Source": "https://github.com/isurfer21/scriptgen_py/"
},
"split_keywords": [
"cli",
"scriptgen",
"bash",
"powershell",
"bat",
"windows",
"macos",
"linux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78cc7295d89701f139f077eb570b77a8931998c1612aa632da02b354f97a0b6f",
"md5": "a4aa39ae22bddfa3497903ec7fa529d9",
"sha256": "8eded9cc5d2fa28099ad46d9b0cce199f312cc10b5b32bed5547e9e59d9fd419"
},
"downloads": -1,
"filename": "scriptgenpy-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a4aa39ae22bddfa3497903ec7fa529d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6010,
"upload_time": "2023-05-01T07:32:29",
"upload_time_iso_8601": "2023-05-01T07:32:29.534889Z",
"url": "https://files.pythonhosted.org/packages/78/cc/7295d89701f139f077eb570b77a8931998c1612aa632da02b354f97a0b6f/scriptgenpy-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24617edd7b3aa2d03dd7e9155545a328d067a53e4900bd9dd0652f4af8edee45",
"md5": "84d28b2ee6770beb5e3d6d0be3e87764",
"sha256": "0309ddfd121fcc0f19cd49361f372cbe642bbae55c829b13c6da2dd4d2557b0c"
},
"downloads": -1,
"filename": "scriptgenpy-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "84d28b2ee6770beb5e3d6d0be3e87764",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7722,
"upload_time": "2023-05-01T07:32:31",
"upload_time_iso_8601": "2023-05-01T07:32:31.485930Z",
"url": "https://files.pythonhosted.org/packages/24/61/7edd7b3aa2d03dd7e9155545a328d067a53e4900bd9dd0652f4af8edee45/scriptgenpy-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-01 07:32:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "isurfer21",
"github_project": "scriptgen_py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scriptgenpy"
}
