pybonsai 2.0.0

PyBonsai procedurally generates ASCII art bonsai trees in your terminal.

PyBonsai-CLI 🌴

PyBonsai is a Python script that generates procedural ASCII art trees in the comfort of your terminal.

                                                        #
                                                    @%%&#@&
                                    ##%              \&%#%&#%%#@
                       #%@&@#    @%&&:&%%#&         &#@_/&&#@# &
                         &@@%@&  &@&&@@%&@@%        %# @@@@#@&
                  @%  #%#%@@@%  @%#&@@&##@@@#          |% &&@
             %%#&%@#  @#~%&%%#%   @%%&@&# %%#          |
            %#&&      @@%%%#&@&%@ %%|%###&%_=\ %&       |
              #@| &% &@% @# %# & &%#|@  @@ &&@%&&&      ; =__=
              &@###_#@  #   @ & @&/# @     #%@%&@%@    __~#@@ %#&@%%##&&
          &#  %##%_%##%;        & ~ %     %@##% @  @ &@&&@  #  @%#@&#@
        %##&%&#@@\  %## ~\        |        &@  & _____ _|#&&&@#@@##@ #
         @%&#@@#@#\/_#_///___;_=_=\:   %&     /:        ~ &##%#&%%#&&
        @%&@@%%@%@#&&%~/_          \:~\  @    /:          ||#@#&& @
          @@@@#&%&&#&@#&             ==\@&%@ //         &%% %@# %
          ######%#%##%# @              %\\###&         &%&@#   #
            @ %%%%#                    @ \=#:       %#@#=@@#@
             @   %#                       |:|       &# &%&%&
                  #                        |||        #   %#&
                                           ;;;
                                            ::|
                              \.--.__.-._../:||\..__________/
                               \             ~  *.     *   /
                                \_________________________ /
                                  ‾                     ‾

Features 🌱

This is a fork of PyBonsai with some additional features.

• Simple package installation 📦
• Better CLI experience 💻
• Infinite mode 🔄
• Save to text files 📄

About other features read more on PyBonsai.

Installation 🔗

Requirements:

• Python 3.9 or greater

Recommended

Use pipx to install PyBonsai globally.

pipx install pybonsai

or using uv to install in temporary, isolated environment:

uvx pybonsai

Alternative

Also can be installed using pip:

pip install pybonsai

or build from source:

git clone https://github.com/DaEtoJostka/PyBonsai-CLI.git
cd PyBonsai-CLI
pip install .

Verify the installation by running:

pybonsai --version

Usage 🔧

Run pybonsai --help for usage:

OPTIONS:
    -h, --help            display help
        --version         display version

    -s, --seed            seed for the random number generator

    -i, --instant         instant mode: display finished tree immediately
    -w, --wait            time delay between drawing characters when not in instant mode [default 0]

    -c, --branch-chars    string of chars randomly chosen for branches [default "~;:="]
    -C, --leaf-chars      string of chars randomly chosen for leaves [default "&%#@"]

    -x, --width           maximum width of the tree [default 80]
    -y, --height          maximum height of the tree [default 25]

    -t, --type            tree type: integer between 0 and 3 inclusive [default random]
    -S, --start-len       length of the root branch [default 15]
    -L, --leaf-len        length of each leaf [default 4]
    -l, --layers          number of branch layers: more => more branches [default 8]
    -a, --angle           mean angle of branches to their parent, in degrees; more => more arched trees [default 40]

    -o, --save PATH       save the tree to a text file. If only a filename is provided, it will be saved in a user's Downloads directory.
    -f, --fixed-window    do not allow window height to increase when tree grows off screen
    
    -I, --infinite        run in infinite mode, infinitely growing same tree
    -n, --new             run in infinite mode, automatically growing new trees
    -W, --wait-infinite   time delay between drawing in infinite mode [default 5]

Other options usage examples see examples.md

Like it?

If you like this project, please consider giving it a ⭐️ on GitHub

Also don't forget to check out PyBonsai

Contributing

If you want to contribute to this project, please feel free to submit a pull request.

License

MIT license