Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lordronz/ascii-art-generator

Ascii art generator made with python
https://github.com/lordronz/ascii-art-generator

ascii-art numpy pillow prompt python terminal

Last synced: 8 days ago
JSON representation

Ascii art generator made with python

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![WTFPL License][license-shield]][license-url]



ASCII-Art-Generator


Convert an Image into an ASCII art!


Explore the docs »




View Demo
·
Report Bug
·
Request Feature

Table of Contents



  1. About The Project



  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Acknowledgments

## About The Project

Idk man i'm just bored

(back to top)

### Built With

* [Pillow](https://python-pillow.org/)
* [NumPy](https://numpy.org/)

(back to top)

## Getting Started

To get a local copy up and running follow these simple example steps.

### Prerequisites

These are things that you'll need to use this program
* Python
* Packages (Pillow and Numpy)
```sh
pip install -r requirements.txt
```

### Installation

1. Clone the repo
```sh
git clone https://github.com/LordRonz/ASCII-Art-Generator.git
```
2. Install required packages
```sh
pip install -r requirements.txt
```

(back to top)

## Usage

Do this to show the help message

```sh
python main.py -h
```

Actual usage

```sh
python main.py shrek.png
```

You can name the output file too

```sh
python main.py shrek.png -o shrex.png
```

Enable color
```sh
python main.py shrek.png -c
```

### Example

> Input Image

CS50 cat

> Output Image

CS50 cat ascii

> Colored Output

CS50 cat ascii colored

MAGE ascii colored

(back to top)

## Roadmap

- [x] Printing the ASCII into the stdout
- [x] Outputing an actual Image
- [x] Add support for arguments
- [ ] Add some coloring options

See the [open issues](https://github.com/LordRonz/ASCII-Art-Generator/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

## License

Distributed under the [WTFPL](http://www.wtfpl.net/) License. See `LICENSE` for more information.

(back to top)

## Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

* [Programming Projects for Advanced Beginners #1: ASCII art](https://robertheaton.com/2018/06/12/programming-projects-for-advanced-beginners-ascii-art/)
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/LordRonz/ASCII-Art-Generator.svg?style=for-the-badge
[contributors-url]: https://github.com/LordRonz/ASCII-Art-Generator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/LordRonz/ASCII-Art-Generator.svg?style=for-the-badge
[forks-url]: https://github.com/LordRonz/ASCII-Art-Generator/network/members
[stars-shield]: https://img.shields.io/github/stars/LordRonz/ASCII-Art-Generator.svg?style=for-the-badge
[stars-url]: https://github.com/LordRonz/ASCII-Art-Generator/stargazers
[issues-shield]: https://img.shields.io/github/issues/LordRonz/ASCII-Art-Generator.svg?style=for-the-badge
[issues-url]: https://github.com/LordRonz/ASCII-Art-Generator/issues
[license-shield]: https://img.shields.io/github/license/LordRonz/ASCII-Art-Generator.svg?style=for-the-badge
[license-url]: https://github.com/LordRonz/ASCII-Art-Generator/blob/master/LICENSE
[product-screenshot]: images/screenshot.png