| Name | vortex-cli JSON |
| Version |
4.18.4
JSON |
| download |
| home_page | None |
| Summary | Vortex CLI |
| upload_time | 2025-02-02 01:31:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2023 jordanamos
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 |
vortex
cli
puakma
tornado
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vortex CLI
[](https://dev.azure.com/amostj/vortex-cli/_build/latest?definitionId=11&branchName=main) [](https://badge.fury.io/py/vortex-cli)
Vortex CLI is a command line alternative to the [Puakma Vortex IDE](https://github.com/brendonupson/PuakmaVortex) that simplifies the process of developing Puakma Applications on a [Puakma Tornado Server](https://github.com/brendonupson/Puakma) using Visual Studio Code. It allows you to clone applications from the server to a local workspace, edit the files using Visual Studio Code, and automatically upload changes to the server as you work.
Vortex CLI also comes pre-packaged with the necessary Puakma .jar files for development.
#### Visual Studio Code and Extensions
While it is possible to use without it, this software has been purposefully designed for use with [Visual Studio Code](https://github.com/microsoft/vscode) and the [Project Manager For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-dependency) or the [Extension Pack For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) extension. This software leverages [Workspaces](https://code.visualstudio.com/docs/editor/workspaces) in Visual Studio Code and manages a `vortex.code-workspace` file within the workspace.
## Installation
1. Install the tool using pip.
```
pip install vortex-cli
```
2. It is recommended to set the workspace you would like to work out of via the `VORTEX_HOME` environment variable.
On Unix:
```
export VORTEX_HOME=/path/to/workspace
```
Otherwise, Vortex CLI will use a default **'vortex-cli-workspace'** directory inside your home directory.
3. Run vortex with the `--init` flag to create your workspace (If it doesn't already exist) and the necessary config files:
```
vortex --init
```
4. Define the servers you will be working with in the `servers.ini` file inside the `.config` directory within your workspace. You can quickly access this using the `code` command to view your workspace in VSCode.
```
vortex code
```
In the `servers.ini` file, you can define as many servers as you need, each with their own unique name. For example:
```
[DEFAULT] ; This section is optional and only useful if you have multiple definitions
port = 80 ; Options provided under DEFAULT will be applied to all definitions if not provided
soap_path = system/SOAPDesigner.pma
default = server1 ; Useful when you have multiple definitions
[server1] ; This can be called whatever you want and can be referenced using the '--server' flag
host = example.com
port = 8080 ; we can overwrite the DEFAULT value
puakma_db_conn_id = 13
username = myuser ; Optional - Prompted at runtime if not provided
password = mypassword ; Optional - Prompted at runtime if not provided
; Optional
lib_path = ; additional jars that should be included in the classpath
java_home = /usr/lib/jvm/java-17-openjdk-amd64/ ; The local path to the JRE to use. Should be the same version running on your server
java_environment_name = JavaSE-17 ; Java Execution Environment name https://docs.osgi.org/reference/eenames.html
```
## Usage
For a full list of commands see `--help`.
### Command Overview
- `code`: Open the workspace in Visual Studio Code.
- `list` (or `ls`): List Puakma Applications on the server or cloned locally. (`ls` is an alias for `vortex list --local`)
- `clone`: Clone Puakma Applications and their design objects into the workspace or in the .pmx format.
- `watch`: Watch the workspace for changes to Design Objects and automatically upload them to the server.
- `clean`: Delete the locally cloned Puakma Application directories in the workspace.
- `config`: View and manage configuration.
- `log`: View the server log.
- `find`: Find Design Objects of cloned applications by name.
- `grep`: Search the contents of cloned Design Objects using a Regular Expression.
- `new`: Create new Design Objects, Applications, or Keywords. Use --update <ID> to update instead.
- `copy`: Copy a Design Object from one application to another.
- `delete`: Delete Design Objects by ID.
- `db`: Interact with Database Connections.
- `docs`: Open the Tornado Server Blackbook.
- `execute`: Execute a command on the server.
Raw data
{
"_id": null,
"home_page": null,
"name": "vortex-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "vortex, cli, puakma, tornado",
"author": null,
"author_email": "Jordan Amos <jordan.amos@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/68/30/4dd3a242485ba2a71451c0adf3a68f0686475102b1ae9771dd79e41e85c5/vortex_cli-4.18.4.tar.gz",
"platform": null,
"description": "# Vortex CLI\n\n[](https://dev.azure.com/amostj/vortex-cli/_build/latest?definitionId=11&branchName=main) [](https://badge.fury.io/py/vortex-cli)\n\nVortex CLI is a command line alternative to the [Puakma Vortex IDE](https://github.com/brendonupson/PuakmaVortex) that simplifies the process of developing Puakma Applications on a [Puakma Tornado Server](https://github.com/brendonupson/Puakma) using Visual Studio Code. It allows you to clone applications from the server to a local workspace, edit the files using Visual Studio Code, and automatically upload changes to the server as you work.\n\nVortex CLI also comes pre-packaged with the necessary Puakma .jar files for development.\n\n#### Visual Studio Code and Extensions\n\nWhile it is possible to use without it, this software has been purposefully designed for use with [Visual Studio Code](https://github.com/microsoft/vscode) and the [Project Manager For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-dependency) or the [Extension Pack For Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) extension. This software leverages [Workspaces](https://code.visualstudio.com/docs/editor/workspaces) in Visual Studio Code and manages a `vortex.code-workspace` file within the workspace.\n\n## Installation\n\n1. Install the tool using pip.\n\n ```\n pip install vortex-cli\n ```\n\n2. It is recommended to set the workspace you would like to work out of via the `VORTEX_HOME` environment variable.\n\n On Unix:\n\n ```\n export VORTEX_HOME=/path/to/workspace\n ```\n\n Otherwise, Vortex CLI will use a default **'vortex-cli-workspace'** directory inside your home directory.\n\n3. Run vortex with the `--init` flag to create your workspace (If it doesn't already exist) and the necessary config files:\n ```\n vortex --init\n ```\n\n4. Define the servers you will be working with in the `servers.ini` file inside the `.config` directory within your workspace. You can quickly access this using the `code` command to view your workspace in VSCode.\n\n ```\n vortex code\n ```\n\n In the `servers.ini` file, you can define as many servers as you need, each with their own unique name. For example:\n\n ```\n [DEFAULT] ; This section is optional and only useful if you have multiple definitions\n port = 80 ; Options provided under DEFAULT will be applied to all definitions if not provided\n soap_path = system/SOAPDesigner.pma\n default = server1 ; Useful when you have multiple definitions\n\n\n [server1] ; This can be called whatever you want and can be referenced using the '--server' flag\n host = example.com\n port = 8080 ; we can overwrite the DEFAULT value\n puakma_db_conn_id = 13\n username = myuser ; Optional - Prompted at runtime if not provided\n password = mypassword ; Optional - Prompted at runtime if not provided\n ; Optional\n lib_path = ; additional jars that should be included in the classpath\n java_home = /usr/lib/jvm/java-17-openjdk-amd64/ ; The local path to the JRE to use. Should be the same version running on your server\n java_environment_name = JavaSE-17 ; Java Execution Environment name https://docs.osgi.org/reference/eenames.html\n ```\n\n## Usage\n\nFor a full list of commands see `--help`.\n\n### Command Overview\n\n- `code`: Open the workspace in Visual Studio Code.\n- `list` (or `ls`): List Puakma Applications on the server or cloned locally. (`ls` is an alias for `vortex list --local`)\n- `clone`: Clone Puakma Applications and their design objects into the workspace or in the .pmx format.\n- `watch`: Watch the workspace for changes to Design Objects and automatically upload them to the server.\n- `clean`: Delete the locally cloned Puakma Application directories in the workspace.\n- `config`: View and manage configuration.\n- `log`: View the server log.\n- `find`: Find Design Objects of cloned applications by name.\n- `grep`: Search the contents of cloned Design Objects using a Regular Expression.\n- `new`: Create new Design Objects, Applications, or Keywords. Use --update <ID> to update instead.\n- `copy`: Copy a Design Object from one application to another.\n- `delete`: Delete Design Objects by ID.\n- `db`: Interact with Database Connections.\n- `docs`: Open the Tornado Server Blackbook.\n- `execute`: Execute a command on the server.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2023 jordanamos\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Vortex CLI",
"version": "4.18.4",
"project_urls": null,
"split_keywords": [
"vortex",
" cli",
" puakma",
" tornado"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "24b65236d49a7493cc1694bc54268a534fa062449e9977f141eb222ab28a20fe",
"md5": "8843bc8ffde9992e24126b98a18cd452",
"sha256": "ead3059948d1036456316471bd96641bd0ff8951e9b1807fbf0f6638c7916737"
},
"downloads": -1,
"filename": "vortex_cli-4.18.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8843bc8ffde9992e24126b98a18cd452",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3106713,
"upload_time": "2025-02-02T01:31:16",
"upload_time_iso_8601": "2025-02-02T01:31:16.618582Z",
"url": "https://files.pythonhosted.org/packages/24/b6/5236d49a7493cc1694bc54268a534fa062449e9977f141eb222ab28a20fe/vortex_cli-4.18.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "68304dd3a242485ba2a71451c0adf3a68f0686475102b1ae9771dd79e41e85c5",
"md5": "5595b511825334a9a5ff59bac3769130",
"sha256": "c8f0b3ab8339be4e306b50a38d2aa801708a59603fe5dddf244ccb2afb546622"
},
"downloads": -1,
"filename": "vortex_cli-4.18.4.tar.gz",
"has_sig": false,
"md5_digest": "5595b511825334a9a5ff59bac3769130",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3098578,
"upload_time": "2025-02-02T01:31:19",
"upload_time_iso_8601": "2025-02-02T01:31:19.864982Z",
"url": "https://files.pythonhosted.org/packages/68/30/4dd3a242485ba2a71451c0adf3a68f0686475102b1ae9771dd79e41e85c5/vortex_cli-4.18.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-02 01:31:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vortex-cli"
}
