Christmas tree

This tool will launch christmas tree right in your terminal, use it just for fun :)

Tools

• python 3.6, 3.7, 3.8
• black
• pylint
• pytest

Usage

Please run following script to obtain latest package from PYPI:

➜ pip install christmas-tree

Then please execute instructions below to launch game from your environment:

from christmas.tree import Tree, ChristmasTree

tree: Tree = ChristmasTree(name="awesome", type_to="real")
tree.launch(speed=.2)

Development notes

Launch source code

To be able to run source code please execute command below:

➜ python -m christmas -h
➜ python -m christmas tree awesome real .2

CI

Project has Travis CI integration using .travis.yml thus code analysis (black, pylint) and unittests (pytest) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

➜ ./run-code-analysis.sh

Also project releases are published automatically and push into PYPI correcondingly using github workflows (pythonpublish.yml file).

Release notes

• 0.3.0
  • Introduce christmas tree package
• 0.2.1
  • Apply code analysis
• 0.2.0
  • Add PYPI package
• 0.1.0
  • Introduce initial app version

Meta

Author – Volodymyr Yahello

Distributed under the MIT license. See LICENSE for more information.

You can reach out me at:

• vyahello@gmail.com
• https://github.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

1. clone the repository
2. configure Git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all development project dependencies