{"id":26026033,"url":"https://github.com/kanakos01/ascii-forge","last_synced_at":"2026-03-13T11:31:12.336Z","repository":{"id":274826278,"uuid":"919578234","full_name":"kanakOS01/ascii-forge","owner":"kanakOS01","description":"A CLI tool to convert image to ASCII art","archived":false,"fork":false,"pushed_at":"2025-02-05T11:06:52.000Z","size":2356,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T00:19:14.083Z","etag":null,"topics":["ascii-art","cli","python3"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/ascii-forge/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kanakOS01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-20T16:42:40.000Z","updated_at":"2025-02-23T15:49:44.000Z","dependencies_parsed_at":"2025-01-29T16:43:47.954Z","dependency_job_id":null,"html_url":"https://github.com/kanakOS01/ascii-forge","commit_stats":null,"previous_names":["kanakos01/ascii-forge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanakOS01%2Fascii-forge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanakOS01%2Fascii-forge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanakOS01%2Fascii-forge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kanakOS01%2Fascii-forge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kanakOS01","download_url":"https://codeload.github.com/kanakOS01/ascii-forge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242227592,"owners_count":20093014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii-art","cli","python3"],"created_at":"2025-03-06T14:32:10.899Z","updated_at":"2026-03-13T11:31:12.283Z","avatar_url":"https://github.com/kanakOS01.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ASCII Forge CLI Tool\r\n\r\n## Overview\r\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.\r\n\r\n## Features\r\n- Convert images to ASCII art.\r\n- Adjustable output width for clarity.\r\n- Invert ASCII output for different visual effects.\r\n- Choose a color scheme for the output.\r\n- Save output as a `.txt` file.\r\n- Save output as a `.png` file.\r\n\r\n## Installation\r\nTo install the ASCII Forge CLI tool, use the following command:\r\n```sh\r\npip install ascii-forge\r\n```\r\n\r\n## Usage\r\nTo run the tool, use the following command:\r\n```sh\r\nascii_forge \u003cimage_path\u003e [OPTIONS]\r\n```\r\n\r\n### Arguments\r\n- `image_path` (required): The path to the image file to be converted.\r\n\r\n### Options\r\n| Option | Short Flag | Default | Description |\r\n|--------|------------|---------|-------------|\r\n| `--width` | `-w` | 100 | Width of the ASCII output (affects clarity). |\r\n| `--invert` | `-i` | False | Invert ASCII output. |\r\n| `--color` | `-c` | None | Choose a color scheme from `COLOR_MAP`. |\r\n| `--save-as-txt` | `-st` | None | Save ASCII output to a `.txt` file. |\r\n| `--save-as-png` | `-sp` | None | Save ASCII output to a `.png` file. |\r\n\r\n### Example Usage\r\n#### Basic Conversion\r\n```sh\r\nascii_forge input.jpg\r\n```\r\n#### Adjusting Width\r\n```sh\r\nascii_forge input.jpg --width 150\r\n```\r\n#### Inverting ASCII Output\r\n```sh\r\nascii_forge input.jpg --invert\r\n```\r\n#### Saving Output as a Text File\r\n```sh\r\nascii_forge input.jpg --save-as-txt output.txt\r\n```\r\n#### Saving Output as a PNG (best accuracy)\r\n```sh\r\nascii_forge input.jpg --save-as-png output.png\r\n```\r\n#### Using Color Options\r\n```sh\r\nascii_forge input.jpg --color red\r\n```\r\n\r\n## Running Locally for Development\r\nTo set up the development environment locally, follow these steps:\r\n\r\n### Directory Structure\r\n```\r\n.\r\n├── ascii_forge\r\n├── ascii_forge.egg-info\r\n├── images\r\n├── LICENSE\r\n├── README.md\r\n├── requirements.txt\r\n├── setup.py\r\n└── venv\r\n```\r\n\r\n### Steps\r\n1. Clone the repository:\r\n   ```sh\r\n   git clone \u003crepository_url\u003e\r\n   cd ascii_forge\r\n   ```\r\n\r\n2. Create and activate a virtual environment:\r\n   ```sh\r\n   python -m venv venv\r\n   source venv/bin/activate  # On macOS/Linux\r\n   venv\\Scripts\\activate  # On Windows\r\n   ```\r\n\r\n3. Install dependencies:\r\n   ```sh\r\n   pip install -r requirements.txt\r\n   ```\r\n\r\n4. Run the CLI tool locally:\r\n   ```sh\r\n   pip install --editable .\r\n   ```\r\n\r\n5. Make changes and test:\r\n   ```sh\r\n   python -m ascii_forge \u003cimage_path\u003e\r\n   ```\r\n\r\n## License\r\nThis project is licensed under the MIT License.\r\n\r\n## Contributions\r\nContributions are welcome! Feel free to open issues and submit pull requests on GitHub.\r\n\r\n## Contact\r\nFor any queries or support, reach out via GitHub or email.\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkanakos01%2Fascii-forge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkanakos01%2Fascii-forge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkanakos01%2Fascii-forge/lists"}