Metadata-Version: 2.1
Name: fart
Version: 0.2.3
Summary: Fart all over your documentation
Author-email: Evan Cushing <evdcush@protonmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2020, evdcush
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/evdcush/fart
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
License-File: LICENSE

::

             _____                    _____                    _____                _____
            /\    \                  /\    \                  /\    \              /\    \
           /::\    \                /::\    \                /::\    \            /::\    \
          /::::\    \              /::::\    \              /::::\    \           \:::\    \
         /::::::\    \            /::::::\    \            /::::::\    \           \:::\    \
        /:::/\:::\    \          /:::/\:::\    \          /:::/\:::\    \           \:::\    \
       /:::/__\:::\    \        /:::/__\:::\    \        /:::/__\:::\    \           \:::\    \
      /::::\   \:::\    \      /::::\   \:::\    \      /::::\   \:::\    \          /::::\    \
     /::::::\   \:::\    \    /::::::\   \:::\    \    /::::::\   \:::\    \        /::::::\    \
    /:::/\:::\   \:::\    \  /:::/\:::\   \:::\    \  /:::/\:::\   \:::\____\      /:::/\:::\    \
   /:::/  \:::\   \:::\____\/:::/  \:::\   \:::\____\/:::/  \:::\   \:::|    |    /:::/  \:::\____\
   \::/    \:::\   \::/    /\::/    \:::\  /:::/    /\::/   |::::\  /:::|____|   /:::/    \::/    /
    \/____/ \:::\   \/____/  \/____/ \:::\/:::/    /  \/____|:::::\/:::/    /   /:::/    / \/____/
             \:::\    \               \::::::/    /         |:::::::::/    /   /:::/    /
              \:::\____\               \::::/    /          |::|\::::/    /   /:::/    /
               \::/    /               /:::/    /           |::| \::/____/    \::/    /
                \/____/               /:::/    /            |::|  ~|           \/____/
      __                _            /:::/    /             |::|   |
     / _|  __ _   _ _  | |_         /:::/    /              \::|   |
    |  _| / _` | | '_| |  _|        \::/    /                \:|   |
    |_|   \__,_| |_|    \__|         \/____/                  \|___|

       ,...
     .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!  --------------------------------- #


.. image:: https://img.shields.io/pypi/v/fart.svg
    :target: https://pypi.python.org/pypi/fart
    :alt: Latest PyPI version

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

What's a fart?

.. code-block::

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

.. code-block::

    $ fart text-box style

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

    $ fart -o one-line text-box style

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




and...

.. code-block::

    $ 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 <https://github.com/asweigart/pyperclip>`_ code
to copy farts to the clipboard.


Big thanks to the members of the
`Laboratory of Plasma Physics (LPP) <https://github.com/LaboratoryOfPlasmaPhysics>`_
who were the original farters on PyPi
with `Find All Roots with a Tree <https://github.com/LaboratoryOfPlasmaPhysics/fart>`_,
but graciously allowed me fart on PyPi.


License
-------
Code is licensed under `BSD-3`_ and any font assets are copyright by original authors.


.. Substitutions:


.. LOCAL FILES:
.. _BSD-3: LICENSE
