FARt all over your documentation
Project description
_____ _____ _____ _____
/\ \ /\ \ /\ \ /\ \
/::\ \ /::\ \ /::\ \ /::\ \
/::::\ \ /::::\ \ /::::\ \ \:::\ \
/::::::\ \ /::::::\ \ /::::::\ \ \:::\ \
/:::/\:::\ \ /:::/\:::\ \ /:::/\:::\ \ \:::\ \
/:::/__\:::\ \ /:::/__\:::\ \ /:::/__\:::\ \ \:::\ \
/::::\ \:::\ \ /::::\ \:::\ \ /::::\ \:::\ \ /::::\ \
/::::::\ \:::\ \ /::::::\ \:::\ \ /::::::\ \:::\ \ /::::::\ \
/:::/\:::\ \:::\ \ /:::/\:::\ \:::\ \ /:::/\:::\ \:::\____\ /:::/\:::\ \
/:::/ \:::\ \:::\____\/:::/ \:::\ \:::\____\/:::/ \:::\ \:::| | /:::/ \:::\____\
\::/ \:::\ \::/ /\::/ \:::\ /:::/ /\::/ |::::\ /:::|____| /:::/ \::/ /
\/____/ \:::\ \/____/ \/____/ \:::\/:::/ / \/____|:::::\/:::/ / /:::/ / \/____/
\:::\ \ \::::::/ / |:::::::::/ / /:::/ /
\:::\____\ \::::/ / |::|\::::/ / /:::/ /
\::/ / /:::/ / |::| \::/____/ \::/ /
\/____/ /:::/ / |::| ~| \/____/
__ _ /:::/ / |::| |
/ _| __ _ _ _ | |_ /:::/ / \::| |
| _| / _` | | '_| | _| \::/ / \:| |
|_| \__,_| |_| \__| \/____/ \|___|
,...
.d' "" mm ,dPYb, I8
dM` MM IP'`Yb I8
mMMmm ,6"Yb. `7Mb,od8 mmMMmm I8 8I 88888888
MM 8) MM MM' "' MM I8 8' I8
MM ,pm9MM MM MM I8 dP ,gggg,gg ,gggggg, I8
MM 8M MM MM MM I8dP dP" "Y8I dP""""8I I8
.JMML. `Moo9^Yo..JMML. `Mbmo I8P i8' ,8I ,8' 8I ,I8,
,d8b,_ ,d8, ,d8b,,dP Y8, ,d88b,
PI8"8888P"Y8888P"`Y88P `Y888P""Y88
_______ _______ ______ _______ I8 `8,
| || _ || _ | | | I8 `8, ___ __ ___
| ___|| |_| || | || |_ _| I8 8I |__ /\ |__) |
| |___ | || |_||_ | | I8 8I | /~~\ | \ |
| ___|| || __ | | | I8, ,8'
| | | _ || | | | | | "Y8P'
|___| |__| |__||___| |_| |___|
_ _ _ _
/\ \ / /\ /\ \ /\ \
/ \ \ / / \ / \ \ \_\ \
/ /\ \ \ / / /\ \ / /\ \ \ /\__ \
/ / /\ \_\ / / /\ \ \ / / /\ \_\ / /_ \ \
/ /_/_ \/_/ / / / \ \ \ / / /_/ / / / / /\ \ \
/ /____/\ / / /___/ /\ \ / / /__\/ / / / / \/_/
/ /\____\/ / / /_____/ /\ \ / / /_____/ / / /
/ / / / /_________/\ \ \ / / /\ \ \ / / /
/ / / / / /_ __\ \_\/ / / \ \ \ /_/ /
\/_/ \_\___\ /____/_/\/_/ \_\/ \_\/
███████ █████ ██████ ████████ ██
██ ██ ██ ██ ██ ██ ██
█████ ███████ ██████ ██ ██
██ ██ ██ ██ ██ ██
██ ██ ██ ██ ██ ██ ██
Figlet ART for documentation. Make text banners to visually divide segments in your code.
Usage
There are two types of farts currently supported:
$ fart text-box style
#=============================================================================#
# text-box style #
#=============================================================================#and…
$ fart figlet style --font big
#=============================================================================#
# __ _ _ _ _ _ #
# / _| (_) | | | | | | | | #
# | |_ _ __ _ | | ___ | |_ ___ | |_ _ _ | | ___ #
# | _| | | / _` | | | / _ \ | __| / __| | __| | | | | | | / _ \ #
# | | | | | (_| | | | | __/ | |_ \__ \ | |_ | |_| | | | | __/ #
# |_| |_| \__, | |_| \___| \__| |___/ \__| \__, | |_| \___| #
# __/ | __/ | #
# |___/ |___/ #
# #
#=============================================================================#You can specify which characters to use for the commenting char (“cap”) and line char (“line”). For example:
$ fart C++ -f georgia11 -c // -l '#' //#############################################################################// // // // .g8"""bgd // // .dP' `M // // dM' ` M M // // MM M M // // MM. mmmmMmmmm mmmmMmmmm // // `Mb. ,' M M // // `"bmmmd' M M // // // //#############################################################################//
Farts are automatically copied to your clipboard for convenience. To disable this functionality, make sure to flag your farts with -n.
To see all available fonts and their supported character-sets, enter fart -s or fart --sample.
There are many, many FIGlet and ascii-art fonts out there. I simply chose the ones I felt were most legible, so that you could ideally parse through a script simply through the mini code viewport available in most IDEs. There are also quite a few fonts in there that are mostly for fun :]. I may add more fonts later, or possibly other types of non-text banners, but for now, only single-row banners are supported.
Installation
Install through pip:
pip install fart
Requirements
Package was built for use in python 3. Probably works in python 2.
Additional required packages:
pyperclip
Acknowledgements
FIGlet fonts are licensed under the BSD-3 by the original authors at http://www.figlet.org.
Big thanks to the members of the Laboratory of Plasma Physics (LPP) who were the original farters on PyPi with Find All Roots with a Tree, but graciously allowed me fart on PyPi.
License
Code is licensed under BSD-3 and any font assets are copyright by original authors.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
