Metadata-Version: 2.1
Name: hyper-prompt
Version: 1.1.1
Summary: Highly Customize-able prompt for your shell
Home-page: https://github.com/artbycrunk/hyper-prompt
Author: Savio Fernandes
Author-email: savio@saviof.com
License: MIT
Download-URL: https://github.com/artbycrunk/hyper-prompt/archive/1.1.0.tar.gz
Description: # Hyper-prompt
        
        [![Version](https://img.shields.io/badge/version-1.1.0-green.svg)]()
        
        [![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/artbycrunk/hyper-prompt.svg)](https://isitmaintained.com/project/artbycrunk/hyper-prompt "Average time to resolve an issue")
        [![Percentage of issues still open](https://isitmaintained.com/badge/open/artbycrunk/hyper-prompt.svg)](https://isitmaintained.com/project/artbycrunk/hyper-prompt "Percentage of issues still open")
        
        [![](https://img.shields.io/badge/TWITTER-%40artbycrunk-blue.svg?logo=twitter&style=flat)](https://twitter.com/artbycrunk)
        [![](https://img.shields.io/badge/gitter-join_chat-1dce73.svg?style=flat&logo=gitter-white)](https://gitter.im/hyper-prompt/hyper-prompt)
        
        
        A Highly Customize-able prompt for your shell
        
        ![header](images/header.gif)
        
        ## Requirements
        
        - Python3
        - Powerline Fonts : https://github.com/powerline/fonts
        
        ## Getting Started
        
        ```bash
        git clone https://github.com/artbycrunk/hyper-prompt
        cd hyper-prompt
        python setup.py install
        ```
        
        ## Configure for your desired shell
        
        ### * Bash
        
        Add the following to your `.bashrc` file:
        
        ```bash
        function _update_ps1() {
            PS1=$(hyper-prompt $?)
        }
        
        if [[ $TERM != linux && ! $PROMPT_COMMAND =~ _update_ps1 ]]; then
            PROMPT_COMMAND="_update_ps1; $PROMPT_COMMAND"
        fi
        ```
        
        ### * Zsh
        
        Add the following to your `.zshrc`:
        
        ```zsh
        function prompt_precmd() {
            PS1="$(hyper-prompt --shell zsh $?)"
        }
        
        function add_prompt_precmd() {
          for s in "${precmd_fn[@]}"; do
            if [ "$s" = "prompt_precmd" ]; then
              return
            fi
          done
          precmd_fn+=(prompt_precmd)
        }
        
        if [ "$TERM" != "linux" ]; then
            add_prompt_precmd
        fi
        ```
        
        ### * Fish
        
        Add the following to your `~/.config/fish/config.fish`:
        
        ```shell
        function fish_prompt
            hyper-prompt --shell bare $status
        end
        ```
        
        ### * tcsh
        
        Add the following to your `.tcshrc`:
        
        ```bash
        alias precmd 'set prompt="`hyper-prompt --shell tcsh $?`"'
        ```
        
        ## Customization Options
        
        ### Config File
        
        Hyper prompt will lookup multiple locations for a config file for options on how to display your prompt..
        
        It will first look for a `hyper_prompt.json` in your current project/folder, if it doesn't exists look for `$HOME/.hyper_prompt.json` else finally look for `$HOME/.config/hyper_prompt/config.json`
        
        Use `~/.config/hyper-prompt/config.json` as a config file for customizations.
        
        Example of a default config
        ```json
        "theme": "default",
        "mode":"patched",
        "segments": [
            "username",
            {
                "type": "virtual",
                // a user built segment which is discoverable via the python path
                "module": "hyper_prompt.segments.virtual"
            }
        ]
        ```
        
        ### Segments
        
        Segments are the building blocks of hyper-prompt
        
        You can mix and match different segments to build your prompt.
        
        
        ## Issues, feature requests, and contributions
        
        * If you come across a problem with the extension, please [file an issue](https://github.com/artbycrunk/hyper-prompt/issues/new)
        * Contributions are always welcome!
        * Any and all feedback is appreciated and welcome!
          - If someone has already [filed an issue](https://github.com/artbycrunk/hyper-prompt/issues) that encompasses your feedback, please leave a 👍/👎 reaction on the issue
          - Otherwise please file a new issue
        
        ## Release Notes
        
        See [CHANGELOG.md](./CHANGELOG.md)
        
        See [Recent Releases](https://github.com/artbycrunk/hyper-prompt/releases)
        
        **Enjoy!**
        
        
Keywords: prompts,shell,bash,zsh
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: develop
