Metadata-Version: 2.1
Name: AsciiDotter
Version: 2.1.0
Summary: CLI tool for turning images into ascii art.
Home-page: https://github.com/wciesialka/ascii-dotter
Author: Willow Ciesialka
Author-email: wciesialka@gmail.com
License: GPL-3.0
Description: # ascii-dotter
        
        Turn an image into "ASCII Art" using Braille Unicode characters.
        
        ## Preamble
        
        As I write this section of my README, it is 11/6/2021. I worked on this project initially almost four years ago, in 2018. It was the first project I was proud of. However, looking at it on my GitHub pinned now brings me a great amount of shame. I no longer like how I handled this program. I violated (albiet at the time, unknowlingly) many software engineering philosophies, and incidentally followed many design anti-patterns. I decided in a energy-drink fueled haze that I would rewrite the entire program, base-up, to the best of my current ability. After this, I hope to create something I can once again be proud of. Then again, in three years time, I might just rewrite it again.
        
        ## Getting Started
        
        ### Setup
        
        You may install the project using `python3 setup.py install` or `./setup.py install`.
        
        ### Requirements
        
        This project was built using Python 3.8.10. A terminal that supports unicode characters is recommended, but not required. Please see [requirements.txt](requirements.txt) for module requirements.
        
        ### Running
        
        After installation, the program may be run directly by using `asciidotter`, or through the module using `python3 -m AsciiDotter`.
        
        ```
        usage: asciidotter [-h] [--output OUTPUT] [--tolerance TOLERANCE] [--method METHOD] [--limit LIMIT] [--invert] input
            -h: Displays help message.
            --output, -o: Output text stream. Optional. Default is sys.stdout.
            --tolerance, -t: Float in range [0.0, 1.0]. Any pixel with a luminance value greater than or equal to this value will be plotted. Default is 0.5.
            --method, -m: Which method to use for determining the luminance value of a pixel. Luminance values are mapped to [0.0, 1.0]. Methods are as follows:
                "AVERAGE", "A": Calculate luminance by taking average of r, g, b.
                "RELATIVE", "R": Calculate luminance by using the [relative luminance](https://en.wikipedia.org/wiki/Relative_luminance) formula. Default.
                "VALUE", "V": Calculate luminance by calculating the value of the pixel in HSV space.
                "WEIGHTED", "W": Calculate luminance by summing the r, g, and b values weighted by their wavelengths.
            --limit, -l: Character limit. Optional. Defaults to 1,048,576.
            --invert, -i: Invert output image. Optional.
            input: Binary input stream of image. Required. 
        
        ```
        
         
         ## Authors
         
         - Will Ciesialka
        
         ## License
        
         This project is licensed under the GNU GENERAL PUBLIC LICENSE VERSION 3. See [LICENSE](LICENSE) for details.
Keywords: python image ascii art
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Artistic Software
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8.10
Description-Content-Type: text/markdown
