Metadata-Version: 2.1
Name: ascii-python
Version: 0.1.0
Summary: A python package for making ascii art
Home-page: https://github.com/Adam-BH/ascii.py
Author: Adam Bhouri
Author-email: adam.bhouri@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: opencv-python
Provides-Extra: dev
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: sdist ; extra == 'dev'

# Ascii_py

A python package for making ascii art

## Installation

Run the following to install:

```ps
$ pip install ascii-python
```

## Usage

### Python Script

Import the ascii_py package, and you're done.

```python
import ascii_py
```

- See more in the [Docs](#-Docs) section

### Terminal

```ps
$ Coming Soon
```

# Developing Ascii_py

To install ascii_py, along with the tools you need to develop and run tests, run the following in your virtualenv:

```ps
$ pip install -e .[dev]
```

# Docs

Import the package

```python
import ascii_py
```

## asciiImage class :

The responsible class for converting ( img <-> ascii )

```python
ai = ascii_py.asciiImage(chars)
#                          ^-- Optional

'''
Chars is a list of strings used in converting images to ascii
orderd from brightest to lowest pixel values:


Default: ["@", "#", "S", "%", "?", "*", "+", ";", ":", ",", "."]
'''
```

### asciiImage.img2ascii

converts an image to ascii text

```python

asciiImg = ai.img2ascii(path, width=150)
#                               ^--Optional

'''
path  : (str)  The path to the image to be converted
width : (int)  the new width of the eimage after being converted
'''

print(asciiImg)  # <-- Returns (str)
```

## Coming Soon :

- asciiImage

  - img2asciiImg (returns an image)
  - ascii2img

- asciiVideo

- Terminal usage


