{"id":22493580,"url":"https://github.com/bigsk1/airats","last_synced_at":"2025-04-23T07:43:13.717Z","repository":{"id":151146590,"uuid":"622465334","full_name":"bigsk1/airats","owner":"bigsk1","description":"ASCII Image Convertor","archived":false,"fork":false,"pushed_at":"2024-06-18T12:59:33.000Z","size":20777,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-16T05:19:49.185Z","etag":null,"topics":["ascii","ascii-art","command-line","flask","homelab","image-processing","linux","python","python3","self-hosted"],"latest_commit_sha":null,"homepage":"","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/bigsk1.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"bigsk1"}},"created_at":"2023-04-02T07:34:17.000Z","updated_at":"2024-06-18T12:59:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"ccc582e4-16b2-4dd4-8bd8-592f9ffc4e00","html_url":"https://github.com/bigsk1/airats","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Fairats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Fairats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Fairats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigsk1%2Fairats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigsk1","download_url":"https://codeload.github.com/bigsk1/airats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250394508,"owners_count":21423360,"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","ascii-art","command-line","flask","homelab","image-processing","linux","python","python3","self-hosted"],"created_at":"2024-12-06T18:54:58.824Z","updated_at":"2025-04-23T07:43:13.683Z","avatar_url":"https://github.com/bigsk1.png","language":"Python","funding_links":["https://github.com/sponsors/bigsk1"],"categories":[],"sub_categories":[],"readme":"# AIRATS  \n\n## ASCII Image Convertor \n![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge\u0026logo=python\u0026logoColor=ffdd54)\n\u003c/br\u003e\nA simple Flask web app and command-line tool to generate ASCII art from an image URL or locally.\n\n\u003c/br\u003e\nBoth Web and Command Line usage\n\n\u003c/br\u003e\n\u003c/br\u003e\n\n![fish](/images/fish.jpg)\n\n\n\nTurn any image locally or remotely into ASCII characters.\n\n\u003c/br\u003e\n\n\n# Installation\n\n## Docker\n\n```bash\ndocker pull bigsk1/airats:latest\n```\nor\nBuild docker image in project root with Dockerfile\n\nClone the repo then\n\n```bash\ncd airats\n```\n\n\n```bash\ndocker build -t \u003cyour_image_name\u003e .\n```\n\n```bash\ndocker run -d -p 5000:5000 \u003cyour_image_name\u003e\n```\n\n\n## Linux\n\n![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge\u0026logo=linux\u0026logoColor=black)\n\n\n1. Clone the repo\n```bash\ngit clone https://github.com/bigsk1/airats.git\n```\n```bash\ncd airats\n```\n\n2. (Optional) Create a virtual environment and activate it:\n\n```bash\npython3 -m venv venv\n\nsource venv/bin/activate\n```\n\u003c/br\u003e\n\n3. Install the required Python packages:\n\n```bash\npip install -r requirements.txt\n```\n\u003c/br\u003e\n\u003c/br\u003e\n\n## Ubuntu 22.04+\n![Ubuntu](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge\u0026logo=ubuntu\u0026logoColor=white)\n### If you don't want the virtual enviroment just make sure you have installed \n\u003c/br\u003e\n\n```bash\nsudo apt install python3 \u0026\u0026 sudo apt install python3-pip \u0026\u0026 sudo apt install python3-flask \u0026\u0026 python3 -m pip install Pillow \u0026\u0026 python3 -m pip install requests \u0026\u0026 python3 -m pip install gunicorn\n```\nrun with python3 app.py in the airats folder\n\n```bash\npython3 app.py\n```\nOpen a web browser and visit [http://localhost:5000](http://localhost:5000) to access the app.\n\n\u003c/br\u003e\n\u003c/br\u003e\n\n## Devcontainer VScode\n\nOpen in devcontainer and run! Find on localhost:5000\n\n---\n\n\n\u003c/br\u003e\n\n## Windows 64bit install\n![Windows 11](https://img.shields.io/badge/Windows%2011-%230079d5.svg?style=for-the-badge\u0026logo=Windows%2011\u0026logoColor=white)\n\nDownload .exe from releases here: https://github.com/bigsk1/airats/releases/tag/v1.0\n\nYou will most likely get a warning when trying to launch because it is not a signed .exe this is normal.\n\n(optional)  build your own by cloning the win64 branch here:\n\n```bash\ngit clone --single-branch --branch win64 https://github.com/bigsk1/airats.git\n```\nsee the requirements.txt for what dependencies are needed\n\n\u003c/br\u003e\n\n# Usage\n\n## Linux\n\n### Web Interface virtual environment in Python\n\n\u003c/br\u003e\n\n1. Run the Flask app (optional):\n\n```bash\nexport FLASK_APP=app.py\n```\n```bash\nflask run --host=0.0.0.0\n```\n\n2. Open a web browser and visit [http://localhost:5000](http://localhost:5000) to access the app.\n\n3. Enter an image URL and width, then click \"Generate ASCII Art\" to see the result.\n\n\n\n\u003c/br\u003e\n\n## Command Line\n\n\u003c/br\u003e\n\nRun any of the following commands from the airats directory:\n\npython3 Main.py \u003cimage_url\u003e [-w WIDTH] [-ht HEIGHT]\n\n\u003c/br\u003e\n\n### Image size can be changed as needed\n\n\u003c/br\u003e\n\nYou can also run an image you have locally using:\n\n\npython3 Main.py your_image.jpg -w 150 -ht 50\n\nor \n\npython3 Main.py https://your-image-url.jpeg -w 150 -ht 50\n\n\n\n```bash\npython3 Main.py images/rat.jpg -w 50 -ht 25\n```\n\u003c/br\u003e\n\nOutput image to a file\n```bash\npython3 Main.py images/rat.jpg -w 80 -o output.txt\n```\n\n\u003c/br\u003e\n\nSupports \n\n    JPEG: .jpg, .jpeg\n    PNG: .png\n    GIF: .gif\n    BMP: .bmp\n    TIFF: .tif, .tiff\n    ICO: .ico\n    WebP: .webp\n\n![Rat Image](/images/rat.jpg)\n\n```bash\n                                 \n                    `,^.`:l!\u003c;,^'   .I, \n                   !-})}rcYCQLYzvt(]?[{; \n                  \"+\u003c+}}{ruYQQQ0QJvft?--` \n                 ir1_-)jrzvucccJZwQvnj?}(, \n               .-CZJf[}rcnuzLu/tjnzvrYYcYtl \n              .1QQCL0XcnrxuO#pCjf/(|fcpXYCx, \n              ]CLXcccXJYJJXzcrttt({[{|/vLQL/^ \n             +JLcrrnvYLCL0QLJCzt)]?[}}-)COLJ}`\n            !XZQcjrvXYCQQOO0QJu(}]?{?]?+zO0Lc\u003e \n           `tL00XnjncvcczXXXvf/|{[])()[]zLCXX{\n           \"rYYJYznxnvczzvuuuj({}]??][)uJCXvct'\n           ,jXXYzcvnnvzXJJJYYzvf/|fnzYCQYYzuvn^\n           .~ncccunuvcXJJXXYJ0mOqZZ00QO0JzvuvvI\n            '?xrrjrzOZJvcvXQOdkhadmQLLLLCznxczI\n              ~jrjt{)vQcvvut){(c0ZOQLLQQCcnuXX,\n   ^l\u003e+]{){]_!,l[/)\u003c!!]ncu1__\u003c]tuXCLQOZQYcvXJu'\n \"+{jj|)fxuzQ0Qzxnx]!!i]cvurftuczCL0OOLJYXYJCt \n^[n/;.    .^!]rCwqQz|?{}cJLOOZZmpwmmO0QCYYCCC~\n`-/[^          '!1uQZ0CQOZmpdppkkbkpmOLCLOZOt'\n ^_(]~!,^````^\"\"`\":~(Jdhao*#*o#MMMhZQC0mmLvj, \n   :~?}}}1)/nXzuvC0qdh#W8#abdpwmOLXXvYYvt-!I'\n      .^\":;l!!l!i+-{(/tjf}???-}{1?]1(/{?\u003c!:,'\n                              ..            \n```\n\n\u003c/br\u003e\n\n\u003ca href='https://github.com/bigsk1/airats/blob/master/LICENSE'\u003eLICENSE\u003c/a\u003e\n\nThis project is licensed under MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigsk1%2Fairats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigsk1%2Fairats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigsk1%2Fairats/lists"}