# ASCII Forge CLI Tool
## Overview
The ASCII Forge CLI tool is a command-line utility that converts images into ASCII art. It provides various options to customize the output, including width, color, inversion, and file-saving capabilities.
## Features
- Convert images to ASCII art.
- Adjustable output width for clarity.
- Invert ASCII output for different visual effects.
- Choose a color scheme for the output.
- Save output as a `.txt` file.
- Save output as a `.png` file.
## Installation
To install the ASCII Forge CLI tool, use the following command:
```sh
pip install ascii-forge
```
## Usage
To run the tool, use the following command:
```sh
ascii_forge <image_path> [OPTIONS]
```
### Arguments
- `image_path` (required): The path to the image file to be converted.
### Options
| Option | Short Flag | Default | Description |
|--------|------------|---------|-------------|
| `--width` | `-w` | 100 | Width of the ASCII output (affects clarity). |
| `--invert` | `-i` | False | Invert ASCII output. |
| `--color` | `-c` | None | Choose a color scheme from `COLOR_MAP`. The `multi` option works only with `--save-as-png`. |
| `--save-as-txt` | `-st` | None | Save ASCII output to a `.txt` file. |
| `--save-as-png` | `-sp` | None | Save ASCII output to a `.png` file. |
### Example Usage
#### Basic Conversion
```sh
ascii_forge input.jpg
```
#### Adjusting Width
```sh
ascii_forge input.jpg --width 150
```
#### Inverting ASCII Output
```sh
ascii_forge input.jpg --invert
```
#### Saving Output as a Text File
```sh
ascii_forge input.jpg --save-as-txt output.txt
```
#### Saving Output as a PNG
```sh
ascii_forge input.jpg --save-as-png output.png
```
#### Using Color Options
```sh
ascii_forge input.jpg --color red
```
## Running Locally for Development
To set up the development environment locally, follow these steps:
### Directory Structure
```
.
├── ascii_forge
├── ascii_forge.egg-info
├── images
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── venv
```
### Steps
1. Clone the repository:
```sh
git clone <repository_url>
cd ascii_forge
```
2. Create and activate a virtual environment:
```sh
python -m venv venv
source venv/bin/activate # On macOS/Linux
venv\Scripts\activate # On Windows
```
3. Install dependencies:
```sh
pip install -r requirements.txt
```
4. Run the CLI tool locally:
```sh
pip install --editable .
```
5. Make changes and test:
```sh
python -m ascii_forge <image_path>
```
## License
This project is licensed under the MIT License.
## Contributions
Contributions are welcome! Feel free to open issues and submit pull requests on GitHub.
## Contact
For any queries or support, reach out via GitHub or email.
Raw data
{
"_id": null,
"home_page": "https://github.com/kanakOS01/ascii-forge",
"name": "ascii-forge",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "ascii-forge ascii forge ascii-art art",
"author": "Kanak Tanwar",
"author_email": "kanaktanwarpro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/19/327e3b724519fa7c256b04a2d2866f728af64ddf7cb67e85202a1e0f6471/ascii-forge-0.7.tar.gz",
"platform": null,
"description": "# ASCII Forge CLI Tool\n\n## Overview\nThe ASCII Forge CLI tool is a command-line utility that converts images into ASCII art. It provides various options to customize the output, including width, color, inversion, and file-saving capabilities.\n\n## Features\n- Convert images to ASCII art.\n- Adjustable output width for clarity.\n- Invert ASCII output for different visual effects.\n- Choose a color scheme for the output.\n- Save output as a `.txt` file.\n- Save output as a `.png` file.\n\n## Installation\nTo install the ASCII Forge CLI tool, use the following command:\n```sh\npip install ascii-forge\n```\n\n## Usage\nTo run the tool, use the following command:\n```sh\nascii_forge <image_path> [OPTIONS]\n```\n\n### Arguments\n- `image_path` (required): The path to the image file to be converted.\n\n### Options\n| Option | Short Flag | Default | Description |\n|--------|------------|---------|-------------|\n| `--width` | `-w` | 100 | Width of the ASCII output (affects clarity). |\n| `--invert` | `-i` | False | Invert ASCII output. |\n| `--color` | `-c` | None | Choose a color scheme from `COLOR_MAP`. The `multi` option works only with `--save-as-png`. |\n| `--save-as-txt` | `-st` | None | Save ASCII output to a `.txt` file. |\n| `--save-as-png` | `-sp` | None | Save ASCII output to a `.png` file. |\n\n### Example Usage\n#### Basic Conversion\n```sh\nascii_forge input.jpg\n```\n#### Adjusting Width\n```sh\nascii_forge input.jpg --width 150\n```\n#### Inverting ASCII Output\n```sh\nascii_forge input.jpg --invert\n```\n#### Saving Output as a Text File\n```sh\nascii_forge input.jpg --save-as-txt output.txt\n```\n#### Saving Output as a PNG\n```sh\nascii_forge input.jpg --save-as-png output.png\n```\n#### Using Color Options\n```sh\nascii_forge input.jpg --color red\n```\n\n## Running Locally for Development\nTo set up the development environment locally, follow these steps:\n\n### Directory Structure\n```\n.\n\u251c\u2500\u2500 ascii_forge\n\u251c\u2500\u2500 ascii_forge.egg-info\n\u251c\u2500\u2500 images\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 setup.py\n\u2514\u2500\u2500 venv\n```\n\n### Steps\n1. Clone the repository:\n ```sh\n git clone <repository_url>\n cd ascii_forge\n ```\n\n2. Create and activate a virtual environment:\n ```sh\n python -m venv venv\n source venv/bin/activate # On macOS/Linux\n venv\\Scripts\\activate # On Windows\n ```\n\n3. Install dependencies:\n ```sh\n pip install -r requirements.txt\n ```\n\n4. Run the CLI tool locally:\n ```sh\n pip install --editable .\n ```\n\n5. Make changes and test:\n ```sh\n python -m ascii_forge <image_path>\n ```\n\n## License\nThis project is licensed under the MIT License.\n\n## Contributions\nContributions are welcome! Feel free to open issues and submit pull requests on GitHub.\n\n## Contact\nFor any queries or support, reach out via GitHub or email.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Turn your images into ASCII art from your terminal",
"version": "0.7",
"project_urls": {
"GitHub Repository": "https://github.com/kanakOS01/ascii-forge",
"Homepage": "https://github.com/kanakOS01/ascii-forge",
"PyPI Project Page": "https://pypi.org/project/ascii-forge/"
},
"split_keywords": [
"ascii-forge",
"ascii",
"forge",
"ascii-art",
"art"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5e844c2afa92979532b57e3e59222b029f0a9e87b629748bfd238d2804469ce4",
"md5": "ed6529c171c10f737369878f21876ebf",
"sha256": "b90b4986f2438a89bc60220d3246703e43fe0aa1e7cd214bf277f2fca6c458b5"
},
"downloads": -1,
"filename": "ascii_forge-0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed6529c171c10f737369878f21876ebf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6056,
"upload_time": "2025-02-05T04:29:28",
"upload_time_iso_8601": "2025-02-05T04:29:28.433723Z",
"url": "https://files.pythonhosted.org/packages/5e/84/4c2afa92979532b57e3e59222b029f0a9e87b629748bfd238d2804469ce4/ascii_forge-0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "eb19327e3b724519fa7c256b04a2d2866f728af64ddf7cb67e85202a1e0f6471",
"md5": "3b08dad08daf1eed22800a8037e7dd3e",
"sha256": "e8859c341c3d0877a590b639e10dba13f8e836f535e66d434e88481e97fc71bb"
},
"downloads": -1,
"filename": "ascii-forge-0.7.tar.gz",
"has_sig": false,
"md5_digest": "3b08dad08daf1eed22800a8037e7dd3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5388,
"upload_time": "2025-02-05T04:29:30",
"upload_time_iso_8601": "2025-02-05T04:29:30.272311Z",
"url": "https://files.pythonhosted.org/packages/eb/19/327e3b724519fa7c256b04a2d2866f728af64ddf7cb67e85202a1e0f6471/ascii-forge-0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 04:29:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kanakOS01",
"github_project": "ascii-forge",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ascii-forge"
}
JSON
