Metadata-Version: 2.1
Name: idem-darwin
Version: 7
Summary: UNKNOWN
Home-page: UNKNOWN
Author: Tyler Johnson
Author-email: tjohnson@saltstack.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: aiofiles (>=0.3.0)
Requires-Dist: dict-toolbox (>=1.5)
Requires-Dist: grainsv2 (>=9)
Requires-Dist: grains-virt (>=2)
Requires-Dist: idem (>=7.2)
Requires-Dist: ifcfg (>=0.16)
Requires-Dist: pop (>=13)
Requires-Dist: pop-config (>=6.8)
Requires-Dist: python-dateutil (>=1.4)
Requires-Dist: rend (>=4.2)

***********
IDEM_DARWIN
***********
**Grains, execution modules, and state modules common to all darwin systems**

INSTALLATION
============

Install idem-darwin directly from pip::

    pip install idem-darwin

DEVELOPMENT INSTALLATION
========================


Clone the `idem_darwin` repo and install with pip::

    git clone https://gitlab.com/saltstack/pop/idem-darwin.git idem_darwin
    pip install -e idem_darwin

EXECUTION
=========
After installation the `grains` command should now be available

TESTING
=======
install `requirements-test.txt` with pip and run pytest::

    pip install -r idem_darwin/requirements-test.txt
    pytest idem_darwin/tests

VERTICAL APP-MERGING
====================
Instructions for extending idem-darwin into an OS-specific idem project

Install pop::

    pip install --upgrade pop

Create a new directory for the project::

    mkdir idem_{specific_darwin_os}
    cd idem_{specific_darwin_os}


Use `pop-seed` to generate the structure of a project that extends `grains` and `idem`::

    pop-seed -t v idem_{specific_darwin_os} -d grains exec states

* "-t v" specifies that this is a vertically app-merged project
*  "-d grains exec states" says that we want to implement the dynamic names of "grains", "exec", and "states"

Add "idem_darwin" to the requirements.txt::

    echo idem-darwin >> requirements.txt

And that's it!  Go to town making grains, execution modules, and state modules specific to your specific darwin-based platform.
Follow the conventions you see in idem_darwin.

For information about running idem states and execution modules check out
https://idem.readthedocs.io


