Metadata-Version: 2.1
Name: saltext.salt-describe
Version: 0.1.1
Summary: Salt Describe Runner
Home-page: http://github.com/saltstack//salt-describe/
Author: Megan Wilhite, Gareth J. Greenaway
Author-email: mwilhite@vmware.com, ggreenaway@vmware.com
License: Apache Software License
Project-URL: Source, http://github.com/saltstack//salt-describe/
Project-URL: Tracker, http://github.com/saltstack//salt-describe/issues
Keywords: salt-extension
Platform: any
Classifier: Programming Language :: Python
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Provides-Extra: changelog
Requires-Dist: towncrier (==21.9.0rc1) ; extra == 'changelog'
Provides-Extra: dev
Requires-Dist: nox (==2021.6.12) ; extra == 'dev'
Requires-Dist: pre-commit (==2.13.0) ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: SaltPyLint ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: furo ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: sphinx-prompt ; extra == 'docs'
Requires-Dist: sphinxcontrib-spelling ; extra == 'docs'
Requires-Dist: pyyaml ; extra == 'docs'
Requires-Dist: importlib-metadata ; (python_version < "3.8") and extra == 'docs'
Provides-Extra: docsauto
Requires-Dist: sphinx-autobuild ; extra == 'docsauto'
Provides-Extra: tests
Requires-Dist: mock (>=3.0.0) ; extra == 'tests'
Requires-Dist: pytest-tempdir (>=2019.10.12) ; extra == 'tests'
Requires-Dist: pytest-helpers-namespace (>=2019.1.8) ; extra == 'tests'
Requires-Dist: pytest-subtests ; extra == 'tests'
Requires-Dist: pytest-timeout ; extra == 'tests'
Requires-Dist: pytest-httpserver ; extra == 'tests'
Requires-Dist: pytest-custom-exit-code (>=0.3) ; extra == 'tests'
Requires-Dist: flaky ; extra == 'tests'
Requires-Dist: markupsafe (==2.0.1) ; extra == 'tests'
Requires-Dist: pytest (>=7.0.1) ; (python_version <= "3.6") and extra == 'tests'
Requires-Dist: pytest (>=7.2.0) ; (python_version > "3.6") and extra == 'tests'
Requires-Dist: pytest-salt-factories[docker] (>=1.0.0rc21) ; (sys_platform != "win32") and extra == 'tests'
Requires-Dist: pytest-salt-factories (>=1.0.0rc21) ; (sys_platform == "win32") and extra == 'tests'

# 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>
