├── .gitattributes ├── .github ├── FUNDING.yml └── workflows │ ├── push-test.yml │ └── python-publish.yml ├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── requirements.txt ├── setup.py └── xontrib └── prompt_starship.py /.gitattributes: -------------------------------------------------------------------------------- 1 | *.xsh text linguist-language=Python 2 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | 2 | # These are supported funding model platforms 3 | 4 | #github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 5 | #patreon: xonssh # Replace with a single Patreon username 6 | #open_collective: # Replace with a single Open Collective username 7 | #ko_fi: # Replace with a single Ko-fi username 8 | #tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 9 | #community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 10 | #liberapay: # Replace with a single Liberapay username 11 | #issuehunt: # Replace with a single IssueHunt username 12 | #otechie: # Replace with a single Otechie username 13 | custom: ['https://github.com/anki-code', 'https://www.buymeacoffee.com/xxh', 'https://github.com/xonsh/xonsh#the-xonsh-shell-community'] 14 | 15 | -------------------------------------------------------------------------------- /.github/workflows/push-test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: push 4 | 5 | jobs: 6 | deploy: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | - name: Set up Python 11 | uses: actions/setup-python@v2 12 | with: 13 | python-version: '3.8' 14 | - name: Install xonsh 15 | run: pip install xonsh 16 | - name: Install xontrib 17 | run: pip install . 18 | - name: Test 19 | run: xonsh -c 'xontrib load prompt_starship' 20 | -------------------------------------------------------------------------------- /.github/workflows/python-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflow will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | name: Upload Python Package 5 | 6 | on: 7 | release: 8 | types: [created] 9 | 10 | jobs: 11 | deploy: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Python 18 | uses: actions/setup-python@v2 19 | with: 20 | python-version: '3.x' 21 | - name: Install dependencies 22 | run: | 23 | python -m pip install --upgrade pip 24 | pip install setuptools wheel twine 25 | - name: Build and publish 26 | env: 27 | TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} 28 | TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} 29 | run: | 30 | python setup.py sdist bdist_wheel 31 | twine upload dist/* 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021, anki-code 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | Starship cross-shell prompt in xonsh shell. 3 |

4 | 5 |

6 | 7 |

8 | If you like the idea click ⭐ on the repo and tweet. 9 |

10 | 11 | Additional features: 12 | 13 | * You can split the prompt to left, right and bottom parts. 14 | 15 | ## Installation 16 | 17 | To install use pip: 18 | 19 | ```bash 20 | # You already have Starship installed. Then: 21 | xpip install xontrib-prompt-starship 22 | # or: xpip install -U git+https://github.com/anki-code/xontrib-prompt-starship 23 | ``` 24 | 25 | ## Usage 26 | 27 | ```bash 28 | xontrib load prompt_starship 29 | ``` 30 | 31 | ## Recommendation 32 | 33 | We suggest to use `@` character to remember about [you're using xonsh syntax](https://github.com/anki-code/xonsh-cheatsheet/blob/main/README.md#three-most-frequent-things-that-newcomers-overlook) and to potentially [spread the word about xonsh](https://github.com/xonsh/xonsh#the-xonsh-shell-community) if you make a screenshot or show your terminal to friends or collegues: 34 | ```ini 35 | mkdir -p ~/.config/ && echo @(""" 36 | [character] 37 | success_symbol = "[@](bold green)" 38 | error_symbol = "[@](bold red)" 39 | """.strip()) > ~/.config/starship_xonsh.toml 40 | 41 | $STARSHIP_CONFIG = '~/.config/starship_xonsh.toml' 42 | xontrib load prompt_starship 43 | ``` 44 | 45 | ## Configuration 46 | 47 | You can set the different starship configs for left, right and bottom parts of prompt when your shell type is prompt-toolkit: 48 | 49 | ```python 50 | $XONTRIB_PROMPT_STARSHIP_LEFT_CONFIG = "~/.config/starship_xonsh_left.toml" 51 | $XONTRIB_PROMPT_STARSHIP_RIGHT_CONFIG = "~/.config/starship_xonsh_right.toml" 52 | $XONTRIB_PROMPT_STARSHIP_BOTTOM_CONFIG = "~/.config/starship_xonsh_bottom.toml" 53 | xontrib load prompt_starship 54 | ``` 55 | 56 | In case of [using starship as part of another prompt](https://github.com/anki-code/xontrib-prompt-bar#using-starship-cross-shell-prompt-to-rendering-right-sections) you can add starship prompt to `$PROMPT_FIELDS` without replacing the current prompt: 57 | ```python 58 | $XONTRIB_PROMPT_STARSHIP_REPLACE_PROMPT = False 59 | xontrib load prompt_starship 60 | print($PROMPT_FIELDS['starship_left']()) 61 | ``` 62 | 63 | ### Prompt bar with starship 64 | 65 | [See also](https://github.com/anki-code/xontrib-prompt-bar#using-starship-cross-shell-prompt-to-rendering-right-sections): 66 | 67 | Prompt bar with starship sections. 68 | 69 | 70 | ### Monochrome prompt 71 | 72 | See also [starship-prompt-mono](https://github.com/anki-code/starship-prompt-mono): 73 | 74 | ![image](https://github.com/user-attachments/assets/9b8a73ab-9efa-4de4-8e17-822db88644a5) 75 | 76 | 77 | ## Known issues 78 | 79 | * [Prompt toolkit issue: the right prompt at the bottom.](https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1241) 80 | * The using of bottom toolbar is not properly tested and adopted to cute appearance. 81 | 82 | ## Credits 83 | * The xontrib-prompt-starship can be used as part of [xontrib-prompt-bar](https://github.com/anki-code/xontrib-prompt-bar). 84 | * This package is the part of [ergopack](https://github.com/anki-code/xontrib-ergopack) - the pack of ergonomic xontribs. 85 | * This package was created with [xontrib cookiecutter template](https://github.com/xonsh/xontrib-cookiecutter). 86 | * [Adding support for xonsh inside Starship](https://github.com/starship/starship/pull/2807) 87 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | xonsh 2 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import setuptools 3 | 4 | try: 5 | with open('README.md', 'r', encoding='utf-8') as fh: 6 | long_description = fh.read() 7 | except (IOError, OSError): 8 | long_description = '' 9 | 10 | setuptools.setup( 11 | name='xontrib-prompt-starship', 12 | version='0.3.6', 13 | license='MIT', 14 | author='anki-code', 15 | author_email='no@no.no', 16 | description="Starship prompt in xonsh shell.", 17 | long_description=long_description, 18 | long_description_content_type='text/markdown', 19 | python_requires='>=3.6', 20 | install_requires=['xonsh'], 21 | packages=['xontrib'], 22 | package_dir={'xontrib': 'xontrib'}, 23 | package_data={'xontrib': ['*.py']}, 24 | platforms='any', 25 | url='https://github.com/anki-code/xontrib-prompt-starship', 26 | project_urls={ 27 | "Documentation": "https://github.com/anki-code/xontrib-prompt-starship/blob/master/README.md", 28 | "Code": "https://github.com/anki-code/xontrib-prompt-starship", 29 | "Issue tracker": "https://github.com/anki-code/xontrib-prompt-starship/issues", 30 | }, 31 | classifiers=[ 32 | "Programming Language :: Python :: 3", 33 | "Programming Language :: Python :: 3.6", 34 | "Programming Language :: Python :: 3.7", 35 | "Programming Language :: Python :: 3.8", 36 | "License :: OSI Approved :: MIT License", 37 | "Operating System :: OS Independent", 38 | "Topic :: System :: Shells", 39 | "Topic :: System :: System Shells", 40 | "Topic :: Terminals", 41 | ] 42 | ) 43 | -------------------------------------------------------------------------------- /xontrib/prompt_starship.py: -------------------------------------------------------------------------------- 1 | """Starship cross-shell prompt in xonsh shell. """ 2 | 3 | import sys as _sys 4 | from pathlib import Path as _Path 5 | 6 | 7 | __xonsh__.env['STARSHIP_SHELL'] = 'xonsh' 8 | __xonsh__.env['STARSHIP_SESSION_KEY'] = __xonsh__.subproc_captured_stdout(['starship','session']).strip() 9 | 10 | 11 | def _starship_prompt(cfg: str) -> None: 12 | import os 13 | with __xonsh__.env.swap({'STARSHIP_CONFIG': cfg} if cfg else {}): 14 | return __xonsh__.subproc_captured_stdout([ 15 | 'starship', 'prompt', 16 | ('--status=' + (str(int( __xonsh__.history[-1].rtn)) if len(__xonsh__.history) > 0 else '0')), 17 | '--cmd-duration' , str(int((__xonsh__.history[-1].ts[1] - __xonsh__.history[-1].ts[0])*1000)) if len(__xonsh__.history) > 0 else '0', 18 | '--jobs', str(len(__xonsh__.all_jobs)), 19 | '--terminal-width', str(os.get_terminal_size().columns), 20 | ]) 21 | 22 | 23 | _replace = __xonsh__.env.get('XONTRIB_PROMPT_STARSHIP_REPLACE_PROMPT' , True) 24 | 25 | 26 | _left_cfg = __xonsh__.env.get('XONTRIB_PROMPT_STARSHIP_LEFT_CONFIG' , __xonsh__.env.get('STARSHIP_CONFIG' , '')) 27 | if _left_cfg: 28 | _left_cfg = _Path(_left_cfg).expanduser() 29 | if not _left_cfg.exists(): 30 | print(f"xontrib-prompt-starship: The path doesn't exist: {_left_cfg}", file=_sys.stderr) 31 | 32 | __xonsh__.env['PROMPT_FIELDS']['starship_left'] = lambda: _starship_prompt(_left_cfg) 33 | if _replace: 34 | __xonsh__.env['PROMPT'] = '{starship_left}' 35 | 36 | 37 | _right_cfg = __xonsh__.env.get('XONTRIB_PROMPT_STARSHIP_RIGHT_CONFIG', '') 38 | if _right_cfg: 39 | _right_cfg = _Path(_right_cfg).expanduser() 40 | if _right_cfg.exists(): 41 | __xonsh__.env['PROMPT_FIELDS']['starship_right'] = lambda: _starship_prompt(_right_cfg) 42 | if _replace: 43 | __xonsh__.env['RIGHT_PROMPT'] = '{starship_right}' 44 | else: 45 | print(f"xontrib-prompt-starship: The path doesn't exist: {_right_cfg}", file=_sys.stderr) 46 | 47 | 48 | _bottom_cfg = __xonsh__.env.get('XONTRIB_PROMPT_STARSHIP_BOTTOM_CONFIG', '') 49 | if _bottom_cfg: 50 | _bottom_cfg = _Path(_bottom_cfg).expanduser() 51 | if _bottom_cfg.exists(): 52 | __xonsh__.env['PROMPT_FIELDS']['starship_bottom_toolbar'] = lambda: _starship_prompt(_bottom_cfg) 53 | if _replace: 54 | __xonsh__.env['BOTTOM_TOOLBAR'] = '{starship_bottom_toolbar}' 55 | else: 56 | print(f"xontrib-prompt-starship: The path doesn't exist: {_bottom_cfg}", file=_sys.stderr) 57 | --------------------------------------------------------------------------------