# Salt Describe
Salt Describe is a Salt Extension used to automate the generation of infrastructure
as code files using Salt to query target machines.
## Quickstart
To get started with your new project:
# Create a new venv
python3 -m venv env --prompt salt-describe
source env/bin/activate
# On mac, you may need to upgrade pip
python -m pip install --upgrade pip
# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant
# Install extension + test/dev/doc dependencies into your environment
python -m pip install -e .[tests,dev,docs]
# Run tests!
python -m nox -e tests-3
# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1
# Build the docs, serve, and view in your web browser:
python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)
# Run the pkg describe function
salt-run describe.pkg <minion-tgt>
# Run the file describe function
salt-run describe.file <minion-tgt> <file name>
# Generate the top file for the minion target based off of previously generated SLS files.
salt-run describe.top <minion-tgt>
Raw data
{
"_id": null,
"home_page": "http://github.com/saltstack//salt-describe/",
"name": "saltext.salt-describe",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "salt-extension",
"author": "Megan Wilhite, Gareth J. Greenaway",
"author_email": "mwilhite@vmware.com, ggreenaway@vmware.com",
"download_url": "https://files.pythonhosted.org/packages/74/21/12c759e457ff68323997f775829a9bc0281ff91fa31f68560ae47e013aeb/saltext.salt-describe-1.0.0.tar.gz",
"platform": "any",
"description": "# Salt Describe\n\nSalt Describe is a Salt Extension used to automate the generation of infrastructure\nas code files using Salt to query target machines.\n\n## Quickstart\n\nTo get started with your new project:\n\n # Create a new venv\n python3 -m venv env --prompt salt-describe\n source env/bin/activate\n\n # On mac, you may need to upgrade pip\n python -m pip install --upgrade pip\n\n # On WSL or some flavors of linux you may need to install the `enchant`\n # library in order to build the docs\n sudo apt-get install -y enchant\n\n # Install extension + test/dev/doc dependencies into your environment\n python -m pip install -e .[tests,dev,docs]\n\n # Run tests!\n python -m nox -e tests-3\n\n # skip requirements install for next time\n export SKIP_REQUIREMENTS_INSTALL=1\n\n # Build the docs, serve, and view in your web browser:\n python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)\n\n # Run the pkg describe function\n salt-run describe.pkg <minion-tgt>\n\n # Run the file describe function\n salt-run describe.file <minion-tgt> <file name>\n\n # Generate the top file for the minion target based off of previously generated SLS files.\n salt-run describe.top <minion-tgt>\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Describe Runner",
"version": "1.0.0",
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "29700c040924f6653644a894b9291afb7648974c5d018f8e9f9661a146009040",
"md5": "d3724695323188d929013760b16a49b0",
"sha256": "98c425919fde59a77a015b635dc3b12cfe69382961ae96c0a6a6d1a5552a8f0e"
},
"downloads": -1,
"filename": "saltext.salt_describe-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3724695323188d929013760b16a49b0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.5",
"size": 30850,
"upload_time": "2023-04-27T19:51:13",
"upload_time_iso_8601": "2023-04-27T19:51:13.362385Z",
"url": "https://files.pythonhosted.org/packages/29/70/0c040924f6653644a894b9291afb7648974c5d018f8e9f9661a146009040/saltext.salt_describe-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "742112c759e457ff68323997f775829a9bc0281ff91fa31f68560ae47e013aeb",
"md5": "78473cde5c49b0e811d994755a5fe684",
"sha256": "627c1f54bbc752dbe51a4bc48fad8366a3a7531dcc00c9aa9cd43bfd8fadf976"
},
"downloads": -1,
"filename": "saltext.salt-describe-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "78473cde5c49b0e811d994755a5fe684",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 60026,
"upload_time": "2023-04-27T19:51:16",
"upload_time_iso_8601": "2023-04-27T19:51:16.593930Z",
"url": "https://files.pythonhosted.org/packages/74/21/12c759e457ff68323997f775829a9bc0281ff91fa31f68560ae47e013aeb/saltext.salt-describe-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 19:51:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "saltext.salt-describe"
}
JSON