Giter Club home page Giter Club logo

asciipy's Introduction

Documentation Status pypi version Discord

asciipy

python library and cli tool to convert images and videos to ascii

pip install asciipy-any

Example output:

image example gif example

additional examples can be found in /examples/

Command line usage:

asciipy [input_file] [output_file] [width] (optional, default=80)

Command line examples:

  • image with default size: asciipy test.png ascii.png

  • video with default size: asciipy test.mp4 ascii.mp4

  • image with custom size: asciipy test.png ascii.png 160

  • video with custom size: asciipy test.mp4 ascii.mp4 160

Optional dependencies (URL and Youtube support):

  • note: these libraries can be manually installed instead. youtube_dl can be used instead of yt-dlp
  • asciipy-any[full] will install requests and yt-dlp to enable downloading from urls and youtube videos.
  • asciipy-any[url] will install requests to enable downloading from urls.
  • asciipy-any[youtube] will install yt-dlp to enable downloading youtube videos.

Python usage:

Python examples:

image to ascii cli

from asciipy import ImageConverter
import sys

img = ImageConverter()
img.convert(sys.argv[1], './ascii.png')
print(f"{sys.argv[1]} converted and written to ./ascii.png")

Planned features:

  • proper gif support (mostly done, but still to buggy to be considered finished)
  • ability to write output as html
  • ability to convert vectors (not sure how i could even go about this)

need help?

asciipy's People

Contributors

anytarseir67 avatar

Stargazers

Nikolaus Schlemm avatar Ori avatar Shelby avatar

Watchers

 avatar Shelby avatar

asciipy's Issues

Should we switch to fully to kwargs?

as the available options for the converter classes increase, i've found that it's common to leave most settings at the default, resulting in needlessly long constructors (e.g. asciipy.ImageConverter(80, None, None, None, True))

the initial design decision was that any argument taken by BaseConverter would be a positional argument, with extra arguments for subclasses being keyword arguments; and although i like the separation of BaseConverter and its subclasses, it makes reading any code with multiple converters a pain in the ass.

i am currently considering:

  • moving everything to kwargs
  • using configuration classes, (I.e. a dataclass that stores the config) similar to what is currently used for the background system.

kwarg example:

converter = asciipy.ImageConverter(width=80, transparent=True)

config class example:

conf = asciipy.Config(width=80, transparent=True)
converter = asciipy.ImageConverter(conf)

or

conf = asciipy.Config()
conf.width = 80
conf.transparent = True
converter = asciipy.ImageConverter(conf)

any feedback would be greatly appreciated!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.