Welcome to asciju’s documentation!¶
asciju¶
Python package that converts image to ascii
Free software: MIT license
Documentation: https://asciju.readthedocs.io.
Python Package Index: https://pypi.org/project/asciju/
Features¶
Conversion image to ASCII art
Usage¶
Convert your image into ASCII art:
from asciju import convert_img_ascii
print(convert_img_ascii('yourimage.jpeg','output.txt'))
Run the python script:
python3 nameofthescript.py
Roadmap¶
Text ASCII art
Video conversion on ASCII Art
Fix CLI argument parser
Improved Documentation
Unit Test
Contribute¶
Contributions are always welcome! Please read the contribution guidelines first.
Help¶
If you need any help anywhere in the process, you can open Github issue or DM a question on Twitter.
License¶
This project is currently licensed under the MIT General Public License v3. i.e. we guarantee end users the freedom to run, study, share, and modify the software.
Made with ❤️ and Python
Installation¶
Stable release¶
To install asciju, run this command in your terminal:
$ pip install asciju
This is the preferred method to install asciju, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for asciju can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/aju100/asciju
Or download the tarball:
$ curl -OJL https://github.com/aju100/asciju/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
Usage¶
To use asciju in a project:
import asciju
Convert your image into ASCII art:
from asciju import convert_img_ascii
print(convert_img_ascii('yourimage.jpeg','output.txt'))
Run the python script:
python3 nameofthescript.py
Output:
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSSSBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&%%**%$&#SBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS$:..::::!**$#BBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS#$!:::::!!!!!!*%$@&&#SBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS#%:::::::!!!!!!!!!**%$&SBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS@:.:!**!!:!!!!!!!!*****%@SBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB%::!%@#SS#&%*!!!!!!!*****%&BBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBS&BB@!!*&&&&&#BS#$****%%%**!**%#BBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBS$*@B*::*@@&SS#BS$*!*%@SSS##@**%SBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBB#**%$:::::!*%$@$%!:!*$SBB#@@$$**#BBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBB&*%*!!::::!!*!:::::!*%@###&#@**%SBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBB&!!!*!:!!**%$*!*::!!!***%%%$$**@BBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBB%!**!!*%$$$**$&@%*%$***!!!!!!*SSSBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS%:!!%@@%**%$&#@$$%****!!!!$@$SBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB$!!!%@#&&&&&@&#@%**%*****%@%&BBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&**********%$$&###&$%%**%$$#BBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&$*****!**%$%**%@&&$***$$%#BBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB%%$$$$****%$%%****%%**@BSSBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS**%&S##&@$$%%$%%%$%%$#BBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS&**%$&SBBBBSSSSS##&@@SBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBSSB@**%$$$#SBBBBBBBBBS@$SBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBS#SBB$**%$$$@&#####&&&&@$$SBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBS#SBBS$**%%$$$@&&@@@$$$@@$@SBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBSS#SBBBB@%%%%$$$$@@@$$$$$$$$#BBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBSS#SBBBBS&$$$$$$$$$$$$$$$$$$@SBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBSSSBBBBBBS@$$$$$$$@@@$$$$$$@@#BBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS$%%%$$$$$$$$$$$@@@&SBBBBBBSSBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS$%%**%%%$$$$%%$$$@#BBBBBBBSBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBS##@%****%%%%%%%%%%%@SSBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBS##&$%**%%%%%*%%%%%@#SBSBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS##@%**%%%%%***$&SSSSBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSS@%**%%****$#SSSSBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS&$%****$@#BBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBS@@@%$@&SBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB#$$###BBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBSBBS&#SBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/aju100/asciju/issues.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation¶
asciju could always use more documentation, whether as part of the official asciju docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/aju100/asciju/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up asciju for local development.
Fork the asciju repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/asciju.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv asciju $ cd asciju/ $ python3 setup.py developCreate a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 asciju tests $ python3 setup.py test or pytest $ toxTo get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-featureSubmit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/aju100/asciju/pull_requests and make sure that the tests pass for all supported Python versions.
Deploying¶
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis will then deploy to PyPI if tests pass.
Credits¶
Development Lead¶
Aju Tamang <ajutamang10@outlook.com>
Contributors¶
wkrt7 (https://github.com/wkrt7)
Roman Shrestha (https://github.com/Romansth)