Skip to content

Sofiane-77/PSChristmasTree-test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 


PSChristmasTree
PSChristmasTree

πŸŽ„ Just a animated Christmas tree on Powershell πŸŽ„

Explore the docs Β»


πŸ—ƒοΈ Table of Contents

  1. Why PSChristmasTree?
  2. What is PSChristmasTree?
  3. Getting Started
  4. Infrastructure Requirements
  5. Roadmap
  6. Contributing and Community
  7. Meet the Team
  8. Getting Help
  9. License
  10. Learn More


πŸ”₯ Why PSChristmasTree?

🀹 Are you an ML engineer or data scientist shipping models to production and juggling a plethora of tools? ZenML is here to help transition your production ML pipelines to production.

The long journey from experimentation to production.

Everyone loves to train ML models, but few talks about shipping them into production, and even fewer can do it well. At ZenML, we believe the journey from model development to production doesn't need to be long and painful.

If you come from unstructured notebooks or scripts with lots of manual processes, ZenML will make the path to production easier and faster for you and your team. Using ZenML allows you to own the entire pipeline - from experimentation to production.

Read more here.

It all started in December when I wanted to learn Powershell. I was looking for project ideas and I found a streamer who was making a Christmas tree in Bash

πŸ’‘ What is PSChristmasTree?

PSChristmasTree is an customizable, open-source powershell module for creating animated Christmas tree. It's build for those who like command lines.

ZenML offers a simple and flexible syntax, is cloud- and tool-agnostic, and has interfaces/abstractions catered toward ML workflows. With ZenML you'll have all your favorite tools in one place, so you can tailor a workflow that caters to your specific needs.

Read more on all tools you can readily use in the integrations section. Can't find your tool? You can always write your own integration to use it with ZenML.

🀸 Getting Started

πŸ’Ύ Installation

Table of Contents

Introduction

PSChristmasTree is a animated Christmas tree on Powershell.

PSChristmasTree displays a christmas tree with decorations that lights up in all colors (by default).

preview

PSChristmasTree has many parameters to customize it including "We Wish You a Merry Christmas" carol that can be played during the display

Back to ToC

Usage

Basic

Show-PSChristmasTree

Advanced

Show-PSChristmasTree [[-AnimationLoopNumber] <Int32>] [[-AnimationSpeed] <Int32>] [[-Colors] <Array>]
[[-Decorations] <Hashtable>] [[-PlayCarol] <Int32>] [[-UICulture] <String>] [<CommonParameters>]

Back to ToC

Installation

From PowerShell Gallery

Install-Module -Name PSChristmasTree

Supported PowerShell Versions and Platforms

  • Windows PowerShell 5.0 or greater
  • PowerShell Core 7.0.3 or greater on Windows/Linux/macOS

From Source

Steps

  • Obtain the source

    git clone https://github.com/Sofiane-77/PSChristmasTree
  • Navigate to the source directory

    cd path/to/PSChristmasTree
  • Import the module

    Import-Module ./PSChristmasTree/PSChristmasTree.psd1
  • Building

    You will need PowerShell Core 7.0 or greater on Windows/Linux/macOS to build the module:

    • The default build is for the currently used version of PowerShell
    Invoke-Build Build
  • Rebuild documentation since it gets built automatically only the first time

    .\build.ps1 -Documentation
  • Build all versions (PowerShell v3, v4, v5, and v6) and documentation

    .\build.ps1 -All
  • Import the module

    Import-Module (Get-ChildItem -Path .\Build\* -Recurse -Include PSChristmasTree.psd1)

To confirm installation: run Get-Help Show-PSChristmasTree -Full in the PowerShell console to get the list of all parameters.

Tests

Pester Tests are located in path/to/PSChristmasTree/Tests folder.

  • In the root folder of your local repository, run:
Invoke-Build Init, Test

Back to ToC

Contributions are welcome

There are many ways to contribute:

  1. Open a new bug report, feature request or just ask a question by opening a new issue here.
  2. Participate in the discussions of issues, pull requests and verify/test fixes or new features.
  3. Submit your own fixes or features as a pull request but please discuss it beforehand in an issue if the change is substantial.
  4. Submit test cases.

Read through our contributing guidelines to learn about our submission process, coding rules and more.

Back to ToC

Creating a Release

  • Update changelog (changelog.md) with the new version number and change set. When updating the changelog please follow the same pattern as that of previous change sets (otherwise this may break the next step).
  • Import the ReleaseMaker module and execute New-Release cmdlet to perform the following actions.
    • Update module manifest (engine/PSScriptAnalyzer.psd1) with the new version number and change set
    • Update the version number in Engine/Engine.csproj and Rules/Rules.csproj
    • Create a release build in out/
    PS> Import-Module .\Utils\ReleaseMaker.psm1
    PS> New-Release
  • Sign the binaries and PowerShell files in the release build and publish the module to PowerShell Gallery.
  • Draft a new release on github and tag main with the new version number.

Back to ToC

Code of Conduct

Help us keep PSChristmasTree open and inclusive. Please read and follow our Code of Conduct. For more information, contact [email protected] with any additional questions or comments.

Back to ToC

Requirements

About

Just a animated Christmas tree on Powershell πŸŽ„

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Contributors