chicolucio / terminal-christmas-tree

A simple terminal Christmas tree made with Python

Python Christmas Tree

A simple CLI Christmas tree made with Python

Installation

Just clone the repository and run

$ python terminal_tree.py

More options below.

Usage

The script name is terminal_tree.py and it accepts the following syntax according to its --help:

$ python terminal_tree.py -h

usage: Python Christmas Tree by Chico Lucio from Ciencia Programada
       [-h] [-s SIZE] [-w WIDTH] [-t]

optional arguments:
  -h, --help            show this help message and exit
  -s SIZE, --size SIZE  Tree height. If even it will be subtracted 1. If less
                        than 7, considered 5. Default: 13
  -w WIDTH, --width WIDTH
                        Screen width. Used to center the tree. Default: 80
  -t, --terminal        Uses the terminal size to center the tree. -s and -w
                        will be ignored

Ctrl-C interrupts the Christmas :-(

Contributing

All contributions are welcome.

Issues

Feel free to submit issues regarding:

• recommendations
• more examples for the README
• enhancement requests and new useful features
• code bugs

Pull requests

• before starting to work on your pull request, please submit an issue first
• fork the repo
• clone the project to your own machine
• commit changes to your own branch
• push your work back up to your fork
• submit a pull request so that your changes can be reviewed

License

MIT, see LICENSE

Citing

If you use terminal-christmas-tree, please consider citing as

F. L. S. Bustamante, terminal-christmas-tree, 2020 - Available at: https://github.com/chicolucio/terminal-christmas-tree

terminal-christmas-tree's Issues

Some ideas

• From functional to OOP
  • create a class Tree initialized with height and screen_size with the current default values
  • boolean parameters balls, color and lights all True by default when instantiated

That way the user could create Tree's with or without balls, colors and random lights instantiating the parameters with True (default) or False. The functions from the current version of the project would be methods of Tree changing the default tree according to the __init__ parameters.

The CLI would have arguments related to balls (-b), color (-c) and lights (-l) so that these could be changed.

• user custom symbols to balls and stars
• user can change the time interval
• the main star can be changed to 🐍 with -p / --pythonsnake command line argument
• Make it snow! ❄ ❅ ❆ ❉ ❊

Bad symbol on macOS with ProFont font and not bright colors