| Name | asciime JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Turn your terminal into a kawaii anime experience! |
| upload_time | 2024-11-10 12:55:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 ASCIIme Contributors 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 |
ascii
anime
terminal
gif
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ASCIIme
Turn your terminal into a kawaii anime experience! ASCIIme is a command-line tool that displays animated ASCII art GIFs in your terminal, with a focus on anime and kawaii content.
## Features
- Display animated GIFs as ASCII art in your terminal
- Support for true color and 256-color terminals
- Automatic caching system for faster loading
- Configurable display settings
- Category-based GIF selection
- Background prefetching for smooth playback
## Installation
First install my fork of the [gif-cli-fast](https://github.com/telnet23/gif-cli-fast) project using:
```bash
python -m pip install git+https://github.com/Felixdiamond/gif-cli-fast
```
Then set up asciime:
```bash
# Install from PyPI
pip install asciime
# Or install from source
git clone https://github.com/Felixdiamond/asciime.git
cd asciime
pip install -e .
```
## Usage
Basic usage:
```bash
# Display a random GIF
asciime --random
# Normal mode with prefetching and caching
asciime
```
**Note**: I'm using the Free Plan on render so my API usually sleeps in 5 mins or so. If you want 100% uptime, you can set up your own server by cloning the repo [asciime-api](https://github.com/Felixdiamond/asciime-api)
If you want to see a random anime gif whenever you open your terminal:
### For Bash users
Add this to your `~/.bashrc`:
```bash
# Display random ASCII anime GIF on terminal start
asciime
```
### For Zsh users
Add this to your `~/.zshrc`:
```bash
# Display random ASCII anime GIF on terminal start
asciime
```
### For Fish users
Add this to your `~/.config/fish/config.fish`:
```bash
# Display random ASCII anime GIF on terminal start
asciime
```
Not sure if this works for windows yet..
## Configuration
ASCIIme can be configured by editing `~/.config/asciime/config.json`. Available options:
```json
{
"display_mode": "truecolor", // Display mode: "truecolor", "256", "256fgbg", or "nocolor"
"max_cache_size_mb": 100, // Maximum cache size in megabytes
"max_cache_age_days": 30, // Maximum age of cached files in days
"prefetch_count": 3, // Number of GIFs to prefetch
"api_url": "https://asciime-api.onrender.com/api", // API endpoint
"preferred_category": null, // Preferred GIF category (null for random)
"loop_count": 3, // Number of times to loop animation (0 for infinite)
"debug": false // Enable debug logging
}
```
## Requirements
- Python 3.8 or higher
- Internet connection for fetching GIFs
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Acknowledgments
- Uses [gif-cli-fast](https://github.com/telnet23/gif-cli-fast) for GIF to ASCII conversion
Raw data
{
"_id": null,
"home_page": null,
"name": "asciime",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ascii, anime, terminal, gif, cli",
"author": null,
"author_email": "Felix Dawodu <diamondfelix006@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bf/48/d0c4c5f8b2a905e04a230ac0ee6eb61f5ed18193ab381abd4ae09703d7a1/asciime-0.1.0.tar.gz",
"platform": null,
"description": "# ASCIIme\n\nTurn your terminal into a kawaii anime experience! ASCIIme is a command-line tool that displays animated ASCII art GIFs in your terminal, with a focus on anime and kawaii content.\n\n## Features\n\n- Display animated GIFs as ASCII art in your terminal\n- Support for true color and 256-color terminals\n- Automatic caching system for faster loading\n- Configurable display settings\n- Category-based GIF selection\n- Background prefetching for smooth playback\n\n## Installation\n\nFirst install my fork of the [gif-cli-fast](https://github.com/telnet23/gif-cli-fast) project using:\n```bash\npython -m pip install git+https://github.com/Felixdiamond/gif-cli-fast\n```\n\nThen set up asciime:\n\n```bash\n# Install from PyPI\npip install asciime\n\n# Or install from source\ngit clone https://github.com/Felixdiamond/asciime.git\ncd asciime\npip install -e .\n```\n\n## Usage\n\nBasic usage:\n\n```bash\n# Display a random GIF\nasciime --random\n\n# Normal mode with prefetching and caching\nasciime\n```\n\n**Note**: I'm using the Free Plan on render so my API usually sleeps in 5 mins or so. If you want 100% uptime, you can set up your own server by cloning the repo [asciime-api](https://github.com/Felixdiamond/asciime-api)\n\nIf you want to see a random anime gif whenever you open your terminal:\n\n### For Bash users\nAdd this to your `~/.bashrc`:\n```bash\n# Display random ASCII anime GIF on terminal start\nasciime\n```\n\n### For Zsh users\nAdd this to your `~/.zshrc`:\n```bash\n# Display random ASCII anime GIF on terminal start\nasciime\n```\n\n### For Fish users\nAdd this to your `~/.config/fish/config.fish`:\n```bash\n# Display random ASCII anime GIF on terminal start\nasciime\n```\n\nNot sure if this works for windows yet..\n\n## Configuration\n\nASCIIme can be configured by editing `~/.config/asciime/config.json`. Available options:\n\n```json\n{\n \"display_mode\": \"truecolor\", // Display mode: \"truecolor\", \"256\", \"256fgbg\", or \"nocolor\"\n \"max_cache_size_mb\": 100, // Maximum cache size in megabytes\n \"max_cache_age_days\": 30, // Maximum age of cached files in days\n \"prefetch_count\": 3, // Number of GIFs to prefetch\n \"api_url\": \"https://asciime-api.onrender.com/api\", // API endpoint\n \"preferred_category\": null, // Preferred GIF category (null for random)\n \"loop_count\": 3, // Number of times to loop animation (0 for infinite)\n \"debug\": false // Enable debug logging\n}\n```\n\n## Requirements\n\n- Python 3.8 or higher\n- Internet connection for fetching GIFs\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Acknowledgments\n\n- Uses [gif-cli-fast](https://github.com/telnet23/gif-cli-fast) for GIF to ASCII conversion\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 ASCIIme Contributors 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": "Turn your terminal into a kawaii anime experience!",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/Felixdiamond/asciime#readme",
"Homepage": "https://github.com/Felixdiamond/asciime",
"Issues": "https://github.com/Felixdiamond/asciime/issues",
"Repository": "https://github.com/Felixdiamond/asciime.git"
},
"split_keywords": [
"ascii",
" anime",
" terminal",
" gif",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "776210db319201c7eaf9c64b35d07baeb5838209707ae65a3785d56a18929973",
"md5": "8ad5e0ecae0388a1c8bb6aa5c1bf1276",
"sha256": "71d9c206fa9508dc77dff253dc4706ac388e5ceaa3c8c57161d04b151e7b2717"
},
"downloads": -1,
"filename": "asciime-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ad5e0ecae0388a1c8bb6aa5c1bf1276",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16699,
"upload_time": "2024-11-10T12:55:22",
"upload_time_iso_8601": "2024-11-10T12:55:22.531739Z",
"url": "https://files.pythonhosted.org/packages/77/62/10db319201c7eaf9c64b35d07baeb5838209707ae65a3785d56a18929973/asciime-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf48d0c4c5f8b2a905e04a230ac0ee6eb61f5ed18193ab381abd4ae09703d7a1",
"md5": "df89883304b3f7237851e226dfdcdfb9",
"sha256": "9bf6d73d9cb448567ffebcf56a4cbec3a9ea479dab1aa5919f5521879754354f"
},
"downloads": -1,
"filename": "asciime-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "df89883304b3f7237851e226dfdcdfb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15827,
"upload_time": "2024-11-10T12:55:43",
"upload_time_iso_8601": "2024-11-10T12:55:43.307885Z",
"url": "https://files.pythonhosted.org/packages/bf/48/d0c4c5f8b2a905e04a230ac0ee6eb61f5ed18193ab381abd4ae09703d7a1/asciime-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-10 12:55:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Felixdiamond",
"github_project": "asciime#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "asciime"
}
