vendy-cli 0.2.4

Code Framework Vending machine

Vendy

Code Vending Machine; speeding up development and enforcing standards
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Vendy is a cli tool designed to make the deployment of scaffolding code in any language easier. Built using CookieCutter the idea is create a tool which can quickly bootstrap projects not just for Python, but other tools such as Terraform. The tool was build with two aims, increase speed of engineers when starting projects, and improve alignment with code standards by make use of templates effortless.

(back to top)

Built With

• Python
• CookieCutter
• Typer
• Rich

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• git cli installed - vendy-cli uses configuration and credentials from here

Installation

pip

pip install vendy-cli

pipx

pipx install vendy-cli

(back to top)

Usage

The first task is to register a template

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)