Coder Social home page Coder Social logo

fart's Introduction

_____                    _____                    _____                _____

/ / / /

/:: /:: /:: /:

/:::: /:::: /:::: ::

/:::::: /:::::: /:::::: ::

/:::/::: /:::/::: /:::/::: ::

/:::/__::: /:::/__::: /:::/__::: ::

/:::: ::: /:::: ::: /:::: ::: /:::

/:::::: ::: /:::::: ::: /:::::: ::: /:::::

/:::/::: ::: /:::/::: ::: /:::/::: :::____ /:::/::

/:::/ ::: :::____/:::/ ::: :::____/:::/ ::: :::| | /:::/ :::____::/ ::: ::/ /::/ ::: /:::/ /::/ ____| /:::/ ::/ /
/____/ ::: /____/ /____/ :::/:::/ / /____:::::::::/ / /:::/ /
:::____ ::::/ / ::::/ / /:::/ /
::/ / /:::/ / ::/____/ ::/ /

/____/ /:::/ / ~| /____/

__ _ /:::/ / |

/ _| __ _ _ _ | |

 _| / _` | | '_| | _| ::/ / :| |

__,_| __| /____/ |___|

,...

.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'

_ _ _ _

/ / / / /

/ / / / _

/ / / / / / / /__

/ / /_ / / / / / /_ / /_

/ /_/_ /_/ / / / / / /_/ / / / / /

/ /____/ / / /___/ / / / /__/ / / / / /_/

/ /____/ / / /_____/ / / / /_____/ / / /

/ / / / /_________/ / / / / / /

/ / / / / /_ ___/ / / /_/ / /_/ ____ /____/_//_/ _/ _/

# --------------------------------- fart! --------------------------------- #

Latest PyPI version

Make text banners to visually divide segments in your code with fart.

What's a fart?

//-----------------------------------------------------------------------------//
//                               This is a fart.                               //
//-----------------------------------------------------------------------------//


#=============================================================================#
#              ____              _           _     _       _                  #
#             / ___|    ___     (_)  ___    | |_  | |__   (_)  ___            #
#             \___ \   / _ \    | | / __|   | __| | '_ \  | | / __|           #
#              ___) | | (_) |   | | \__ \   | |_  | | | | | | \__ \           #
#             |____/   \___/    |_| |___/    \__| |_| |_| |_| |___/           #
#                                                                             #
#=============================================================================#

Fart is short for Figlet ART. This program is very similar to Figlet, and most fonts are borrowed from from it. Fart is focused on making text banners for use in code documentation.

As such, all generated text is encapsulated by commenting characters and copied to clipboard, so you can easily paste your fart into your code.

Usage

There are two types of farts currently supported:

$ fart text-box style

#=============================================================================#
#                                text-box style                               #
#=============================================================================#

$ fart -o one-line text-box style

#=========================  one-line text-box style  =========================#

and...

$ fart --font big figlet style

#=============================================================================#
#        __   _           _          _             _             _            #
#       / _| (_)         | |        | |           | |           | |           #
#      | |_   _    __ _  | |   ___  | |_     ___  | |_   _   _  | |   ___     #
#      |  _| | |  / _` | | |  / _ \ | __|   / __| | __| | | | | | |  / _ \    #
#      | |   | | | (_| | | | |  __/ | |_    \__ \ | |_  | |_| | | | |  __/    #
#      |_|   |_|  \__, | |_|  \___|  \__|   |___/  \__|  \__, | |_|  \___|    #
#                  __/ |                                  __/ |               #
#                 |___/                                  |___/                #
#                                                                             #
#=============================================================================#

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                           //
//                                                                             //
//#############################################################################//

You can also optionally pad the inside of "cap" char with a space, as it 'space following a comment char' is a common linting rule and will ruin your farts.

If you can't fart around your linter due to this rule, this is the option for you!

Specify the -p --pad-caps option:

$ fart -p -f small Nice try Black!

# =============================================================================== #
#    _  _   _                _                    ___   _               _     _   #
#   | \| | (_)  __   ___    | |_   _ _   _  _    | _ ) | |  __ _   __  | |__ | |  #
#   | .` | | | / _| / -_)   |  _| | '_| | || |   | _ \ | | / _` | / _| | / / |_|  #
#   |_|\_| |_| \__| \___|    \__| |_|    \_, |   |___/ |_| \__,_| \__| |_\_\ (_)  #
#                                        |__/                                     #
#                                                                                 #
# =============================================================================== #

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.

Installation

Install through pip:

pip install fart

Requirements

This package was built for use in Python 3 in Linux. I expect this package should work for other environments, but no support for other OS is planned.

Acknowledgements

FIGlet fonts are licensed under the BSD-3 by the original authors at http://www.figlet.org.

This package also uses pyperclip code to copy farts to the clipboard.

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.

fart's People

Contributors

evdcush avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

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.