Python_CLI

Python CLI Tool

project_description
Explore the docs »

View Demo · 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

About The Project

This is a simple Command Line Interface Tool purely made in Python.
The given tool has three basic user options which are -h, -i and -update.
The -h option shortly describes the tool and the available options.
The -i option will read an input csv file and a dependency@version and accordingly it will produce an output csv file.
The output csv file will contain the version number and also true or false to indicate whether the given version in input is less or greater than the current version number.
The -update option is similar to -i but through this option the user also creates a Pull Request if the current version of the dependency is less than the input version.
Hence this is a CLI tool that can help a user for release process related work.

(back to top)

Built With

• Python3

(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

This is an example of how to list things you need to use the software and how to install them.

• Python should be installed on your machine.

Installation

1. Clone the repo

   git clone https://github.com/dyte-submissions/dyte-vit-2022-Vikash-techie.git

2. Run the python code

   python Vikash_SDK_Tool.py

3. Run the help function

   python Vikash_SDK_Tool.py -h

(back to top)

Usage

• To run the -i option the user should type python Vikash_SDK_Tool.py -i input.csv dependency@version_number

• To run the -update option the user should type python Vikash_SDK_Tool.py -update -i input.csv dependency@version_number
  

• This is what a user's input file will look like.

• This is what a user's output file will look like after running the update option.

(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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Vikash Sunil - vikashsunil01@gmail.com

Project Link: https://github.com/github_username/repo_name

(back to top)