# !!Project is Archived!!
> Salt Project / VMware has ended active development of this project, this repository will no longer be updated.
- The community has created and maintained a better alternative to the development of Salt extensions: [salt-extensions/salt-extension-copier](https://github.com/salt-extensions/salt-extension-copier) (Create and maintain Salt extensions using Copier)
# salt-extension
> Tool to simplify the creation of a new salt extension.
## The why
`salt-extension` is a Python-based CLI tool for generating a project scaffolding
to easily extend [salt](https://github.com/saltstack/salt/) with exec modules, state modules, and more.
Extensions make life easier in several ways:
- Deployments where proprietary Python modules are developed internally, like at enterprises that want to extend `salt` functionality without modifying `salt` itself, can follow a standard.
- Extensions can develop and release at a faster speed than `salt` itself. No need to wait for a specific major release.
- Developing extensions as separate repos allows for smaller, more isolated test suites that are tailored specifically to the scope of the extension.
This approach to development, of the `salt` ecosystem, could also assist in the powers of [Tiamat](https://gitlab.com/saltstack/pop/tiamat) (resources: [SEP26](https://github.com/saltstack/salt-enhancement-proposals/pull/34) // [tiamat-pip](https://gitlab.com/saltstack/pop/tiamat-pip) source code).
Converting existing module sets into extensions could begin treating `salt` as a more "pluggable"/"extensible" ecosystem, and could make it easier to understand what modules haven’t been contributed to in a long time. It is difficult to maintain so many modules within `salt` that manage and orchestrate an ocean of APIs, operating systems, clouds, etc.
## Quickstart
The best way to use this project is with [pipx][pipx]:
$ pipx install salt-extension
$ mkdir my_extension
$ cd my_extension
$ create-salt-extension my_extension -l states -l module
Author: John Example Doe
Author email: jd@example.com
Summary: An example Salt Extension Module
Url: https://example.com/my-saltext
License (apache, other): apache
Then follow the other output instructions.
If all goes well, you should be able to run:
$ salt-call --local my_extension.example_function text="it worked!"
local:
it worked!
Happy hacking!
[pipx]: https://pypi.org/project/pipx/
Raw data
{
"_id": null,
"home_page": "https://saltproject.io",
"name": "salt-extension",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "salt-extension",
"author": "Pedro Algarvio",
"author_email": "pedro@algarvio.me",
"download_url": "https://files.pythonhosted.org/packages/61/a7/75fcfcc38ddd7bfc5327e9c8a0dadec575395c75234e8f749a7a5a8d0cd6/salt_extension-1.0.0.tar.gz",
"platform": "any",
"description": "# !!Project is Archived!!\n\n> Salt Project / VMware has ended active development of this project, this repository will no longer be updated.\n\n- The community has created and maintained a better alternative to the development of Salt extensions: [salt-extensions/salt-extension-copier](https://github.com/salt-extensions/salt-extension-copier) (Create and maintain Salt extensions using Copier)\n\n# salt-extension\n\n> Tool to simplify the creation of a new salt extension.\n\n## The why\n\n`salt-extension` is a Python-based CLI tool for generating a project scaffolding\nto easily extend [salt](https://github.com/saltstack/salt/) with exec modules, state modules, and more.\n\nExtensions make life easier in several ways:\n\n- Deployments where proprietary Python modules are developed internally, like at enterprises that want to extend `salt` functionality without modifying `salt` itself, can follow a standard.\n- Extensions can develop and release at a faster speed than `salt` itself. No need to wait for a specific major release.\n- Developing extensions as separate repos allows for smaller, more isolated test suites that are tailored specifically to the scope of the extension.\n\nThis approach to development, of the `salt` ecosystem, could also assist in the powers of [Tiamat](https://gitlab.com/saltstack/pop/tiamat) (resources: [SEP26](https://github.com/saltstack/salt-enhancement-proposals/pull/34) // [tiamat-pip](https://gitlab.com/saltstack/pop/tiamat-pip) source code).\n\nConverting existing module sets into extensions could begin treating `salt` as a more \"pluggable\"/\"extensible\" ecosystem, and could make it easier to understand what modules haven\u2019t been contributed to in a long time. It is difficult to maintain so many modules within `salt` that manage and orchestrate an ocean of APIs, operating systems, clouds, etc.\n\n## Quickstart\n\nThe best way to use this project is with [pipx][pipx]:\n\n $ pipx install salt-extension\n $ mkdir my_extension\n $ cd my_extension\n $ create-salt-extension my_extension -l states -l module\n Author: John Example Doe\n Author email: jd@example.com\n Summary: An example Salt Extension Module\n Url: https://example.com/my-saltext\n License (apache, other): apache\n\nThen follow the other output instructions.\n\nIf all goes well, you should be able to run:\n\n $ salt-call --local my_extension.example_function text=\"it worked!\"\n local:\n it worked!\n\nHappy hacking!\n\n[pipx]: https://pypi.org/project/pipx/\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Tool to simplify the creation of a new salt extension",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://saltproject.io",
"Source": "https://github.com/saltstack/salt-extension",
"Tracker": "https://github.com/saltstack/salt-extension/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61a775fcfcc38ddd7bfc5327e9c8a0dadec575395c75234e8f749a7a5a8d0cd6",
"md5": "6e9544f32851b4af0b9116eb02485141",
"sha256": "e79bc7223de4ec8dee760f20ebc447bd4db102469c37c12714aa74edd84472fc"
},
"downloads": -1,
"filename": "salt_extension-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6e9544f32851b4af0b9116eb02485141",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 47083,
"upload_time": "2024-08-02T18:37:47",
"upload_time_iso_8601": "2024-08-02T18:37:47.447200Z",
"url": "https://files.pythonhosted.org/packages/61/a7/75fcfcc38ddd7bfc5327e9c8a0dadec575395c75234e8f749a7a5a8d0cd6/salt_extension-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 18:37:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "saltstack",
"github_project": "salt-extension",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "salt-extension"
}
JSON
