| Name | atty JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-06-24 14:50:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Michell Stuttgart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cli
interactive
console
terminal
alacritty
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h2 align="center">
<a href="https://pypi.org/project/atty/">
<img src="https://github.com/mstuttgart/atty/assets/8174740/2ce05801-e28a-470c-b755-68081671344f" width="15%">
</a>
<br>
Atty
</h2>
<p align="center">
<a href="https://github.com/mstuttgart/atty/actions/workflows/test.yml">
<img alt="GitHub Workflow Status" src="https://github.com/mstuttgart/atty/actions/workflows/test.yml/badge.svg">
</a>
<a href="https://codecov.io/gh/mstuttgart/atty">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/mstuttgart/atty?color=fcd800">
</a>
<a href="https://pypi.org/project/atty">
<img src="https://img.shields.io/pypi/dm/atty?color=fcd800" alt="Downloads">
</a>
<a href="https://pypi.org/project/atty">
<img src="https://img.shields.io/pypi/v/atty.svg?" alt="Ratings">
</a>
<a href="https://pypi.org/project/atty/">
<img src="https://img.shields.io/pypi/pyversions/atty.svg" alt="Version">
</a>
</p>
<p align="center">
<a href="#about">About</a> |
<a href="#install">Install</a> |
<a href="#how-to-use">How to Use</a> |
<a href="#configuration">Configuration</a> |
<a href="#contribute">Contribute</a>
</p>
## About
`Atty` is a `cli` utility for [Alacritty](https://github.com/alacritty/alacritty) color theme switching.
> [!NOTE]
> This hasn't been tested on Windows and OS X yet. There'll probably be issues with default settings, as it's looking for the `$HOME/.config/alacritty` folder, but after setting the `--config` and `--theme_dir` flags, it should work just fine.
## Install
The recommended way to get _atty_ is to **install the latest stable release**:
```sh
pip install atty
```
or using [pipx](https://github.com/pypa/pipx):
```sh
pipx install atty
```
## How to Use
The default themes folder is in `$HOME/.config/alacritty/themes/`.
Example:
```
.
├── alacritty
│ ├── alacritty.yml
│ └── themes
```
> [!TIP]
> You can get the oficial themes repository of `alacritty`:
>
> `git clone git@github.com:alacritty/alacritty-theme.git $HOME/.config/alacritty/themes/`
Next, run `atty` and select you favority theme:
> atty
```sh
Up and Down keys: navegate on themes list
Left and Right keys: switch page
ESC key: abort
Select Color:
> Cobalt2
Mariana
afterglow
alabaster
alabaster_dark
argonaut
atom_one_light
ayu_dark
ayu_light
baitong
Page 1/11
(enter to confirm)
```
## Configuration
The utility can be configured by passing additional flags/parameters:
```sh
aty --help
Usage: atty [OPTIONS]
CLI for Alacritty color theme and configuration switching.
By default, atty will look for the alacritty's configuration file in
"$HOME/.config/alacritty/alacritty.toml", for the theme files in
"$HOME/.config/alacritty/themes" folder.
Options:
--version Show the version and exit.
-c, --config TEXT Absolute path of Alacritty configuration file
-d, --theme_dir TEXT Absolute path of themes folder
-t, --theme TEXT Select a theme by name instead of showing prompt.
-h, --help Show this message and exit.
```
## Contribute
See this *guideline* [here](https://github.com/mstuttgart/atty/blob/main/.github/CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "atty",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, interactive, console, terminal, alacritty",
"author": null,
"author_email": "Michell Stuttgart <michellstut@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ad/c9/d1bdf3a088e9054c5d3efee6763241a577ab4cdc48f9ade9a04b3d49d024/atty-0.1.0.tar.gz",
"platform": null,
"description": "<h2 align=\"center\">\n <a href=\"https://pypi.org/project/atty/\">\n <img src=\"https://github.com/mstuttgart/atty/assets/8174740/2ce05801-e28a-470c-b755-68081671344f\" width=\"15%\">\n </a>\n <br>\n Atty\n</h2>\n\n<p align=\"center\">\n\n <a href=\"https://github.com/mstuttgart/atty/actions/workflows/test.yml\">\n <img alt=\"GitHub Workflow Status\" src=\"https://github.com/mstuttgart/atty/actions/workflows/test.yml/badge.svg\">\n </a>\n\n <a href=\"https://codecov.io/gh/mstuttgart/atty\">\n <img alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/github/mstuttgart/atty?color=fcd800\">\n </a>\n\n <a href=\"https://pypi.org/project/atty\">\n <img src=\"https://img.shields.io/pypi/dm/atty?color=fcd800\" alt=\"Downloads\">\n </a>\n\n <a href=\"https://pypi.org/project/atty\">\n <img src=\"https://img.shields.io/pypi/v/atty.svg?\" alt=\"Ratings\">\n </a>\n\n <a href=\"https://pypi.org/project/atty/\">\n <img src=\"https://img.shields.io/pypi/pyversions/atty.svg\" alt=\"Version\">\n </a>\n\n</p>\n\n<p align=\"center\">\n <a href=\"#about\">About</a> |\n <a href=\"#install\">Install</a> |\n <a href=\"#how-to-use\">How to Use</a> |\n <a href=\"#configuration\">Configuration</a> |\n <a href=\"#contribute\">Contribute</a>\n</p>\n\n## About\n\n`Atty` is a `cli` utility for [Alacritty](https://github.com/alacritty/alacritty) color theme switching.\n\n> [!NOTE]\n> This hasn't been tested on Windows and OS X yet. There'll probably be issues with default settings, as it's looking for the `$HOME/.config/alacritty` folder, but after setting the `--config` and `--theme_dir` flags, it should work just fine.\n\n## Install\n\nThe recommended way to get _atty_ is to **install the latest stable release**:\n\n```sh\npip install atty\n```\n\nor using [pipx](https://github.com/pypa/pipx):\n\n```sh\npipx install atty\n```\n\n## How to Use\n\nThe default themes folder is in `$HOME/.config/alacritty/themes/`.\n\nExample:\n\n```\n.\n\u251c\u2500\u2500 alacritty\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 alacritty.yml\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 themes\n```\n\n> [!TIP]\n> You can get the oficial themes repository of `alacritty`:\n>\n> `git clone git@github.com:alacritty/alacritty-theme.git $HOME/.config/alacritty/themes/`\n\nNext, run `atty` and select you favority theme:\n\n> atty\n\n```sh\nUp and Down keys: navegate on themes list\nLeft and Right keys: switch page\nESC key: abort\nSelect Color:\n> Cobalt2\n Mariana\n afterglow\n alabaster\n alabaster_dark\n argonaut\n atom_one_light\n ayu_dark\n ayu_light\n baitong\n\nPage 1/11\n\n(enter to confirm)\n```\n\n## Configuration\n\nThe utility can be configured by passing additional flags/parameters:\n\n```sh\naty --help\n\nUsage: atty [OPTIONS]\n\n CLI for Alacritty color theme and configuration switching.\n\n By default, atty will look for the alacritty's configuration file in\n \"$HOME/.config/alacritty/alacritty.toml\", for the theme files in\n \"$HOME/.config/alacritty/themes\" folder.\n\nOptions:\n --version Show the version and exit.\n -c, --config TEXT Absolute path of Alacritty configuration file\n -d, --theme_dir TEXT Absolute path of themes folder\n -t, --theme TEXT Select a theme by name instead of showing prompt.\n -h, --help Show this message and exit.\n```\n\n\n## Contribute\n\nSee this *guideline* [here](https://github.com/mstuttgart/atty/blob/main/.github/CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Michell Stuttgart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": null,
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/mstuttgart/atty/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/mstuttgart/atty",
"Repository": "https://github.com/mstuttgart/atty"
},
"split_keywords": [
"cli",
" interactive",
" console",
" terminal",
" alacritty"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3c22fb4a5e2ad10964bbd8c215cdd807fc48ff277c675444ebe8de41133beed",
"md5": "42ff9925592d09faca60c88ff2c13c10",
"sha256": "df56f566dffc046a5f99bb6e320513b3b24ee7244ed4a9dcffe5ac5110fa2452"
},
"downloads": -1,
"filename": "atty-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "42ff9925592d09faca60c88ff2c13c10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6455,
"upload_time": "2024-06-24T14:50:17",
"upload_time_iso_8601": "2024-06-24T14:50:17.926556Z",
"url": "https://files.pythonhosted.org/packages/e3/c2/2fb4a5e2ad10964bbd8c215cdd807fc48ff277c675444ebe8de41133beed/atty-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "adc9d1bdf3a088e9054c5d3efee6763241a577ab4cdc48f9ade9a04b3d49d024",
"md5": "b22c98ba5404cc183fe508d577876616",
"sha256": "b4e554ccd7dce47032af5510363a0128c123ac235e9f69baa5d9664683c880f5"
},
"downloads": -1,
"filename": "atty-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b22c98ba5404cc183fe508d577876616",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6098,
"upload_time": "2024-06-24T14:50:19",
"upload_time_iso_8601": "2024-06-24T14:50:19.202527Z",
"url": "https://files.pythonhosted.org/packages/ad/c9/d1bdf3a088e9054c5d3efee6763241a577ab4cdc48f9ade9a04b3d49d024/atty-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 14:50:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mstuttgart",
"github_project": "atty",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "atty"
}
