Metadata-Version: 2.1
Name: daktari
Version: 0.0.33
Summary: Assist in setting up and maintaining developer environments
Home-page: https://github.com/sonocent/daktari
Author: Matt Russell
Author-email: matthew.russell@sonocent.com
License: MIT
Description: **Daktari** is a tool to help the initial setup and ongoing maintenance of developer environments. It runs a series of checks (for example, that required software is installed) and provides suggestions on how to fix the issue if the check fails.
        
        ## Configuration
        
        In the root of the project repository, create a `.daktari.py` configuration file listing the checks you want run. For example,
        
        ```python
        from daktari.checks.git import *
        
        version = "0.0.33"
        title = "My Project"
        
        checks = [
            GitInstalled(),
            GitLfsInstalled(),
            GitLfsSetUpForUser(),
            GitLfsFilesDownloaded(),
            GitCryptInstalled(),
        ]
        ```
        
        Then run `daktari` to diagnose your environment:
        
        ```
        $ daktari
        ✅ [git.installed] Git is installed
        ✅ [git.lfs.installed] Git LFS is installed
        ✅ [git.lfs.setUpForUser] Git LFS is set up for the current user
        ✅ [git.lfs.filesDownloaded] Git LFS files have been downloaded
        ❌ [git.crypt.installed] git-crypt is not installed
        ┌─💡 Suggestion ─────────┐
        │ brew install git-crypt │
        └────────────────────────┘
        ```
        
        ## Custom Check
        
        You can write a custom check as a Python class within `.daktari.py`, and include it in your list of checks. Example check implementation:
        
        ```python
        class GitCryptInstalled(Check):
            name = "git.crypt.installed"
            depends_on = [GitInstalled]
        
            suggestions = {
                OS.OS_X: "<cmd>brew install git-crypt</cmd>",
                OS.UBUNTU: "<cmd>sudo apt install git-crypt</cmd>",
                OS.GENERIC: "Install git-crypt (https://www.agwa.name/projects/git-crypt/)",
            }
        
            def check(self):
                return self.verify(can_run_command("git crypt version"), "git-crypt is <not/> installed")
        ```
        
        ## Release instructions
        
        ```
        bumpversion --verbose patch
        python setup.py sdist bdist_wheel
        twine check dist/*
        twine upload dist/*
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Requires-Python: >=3.6
Description-Content-Type: text/markdown
