dyte-submissions / dyte-vit-2022-harshkanani014

Command Line Interface (CLI) Tool to check version of dependency present in repositories file uploaded by user. Dyte CLI tool provides features to check satisfied version and return output.csv with all satisfied version and also creates Pull request to update particular version of dependency.

Dyte Dependency checker 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. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Published Package on Pypi : https://pypi.org/project/Dyte-Dependency-version-checker/

Dyte SDK Tool is Command Line Interface (CLI) Tool to check version of dependency present in repositories file uploaded by user. Dyte CLI tool provides the following features:

1. Check satisfied version and return output.csv with all satisfied versions.
2. Also creates Pull request to update particular version of multiple dependencies in single command.
3. Easy to use CLI tool with clean and clear output.
4. Create PR request for updating dependencies.
5. Support package.json (NodeJS) and requirements.txt (Python).

(back to top)

Extra Features

1. Published package on Pypi so anyone can use using Pypi Dyte Dependency version checker

2. supports NodeJs and Python Both

3. Can check muliple dependencies with single command on both Python and NodeJS Dependency file

4. Proper format of csv along with all information

5. Can also check and update Pull request for Python libraries as well

6. Re-usable code so can add more language support in future

7. Styling in CLI

Built With

• Python

Libraries used

• Git
• pyinstaller
• click
• progress
• pyfiglet

(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 [https://www.python.org/downloads/]
• pip

  python3 -m pip install --upgrade pip

Installation of code from package published on Pypi (Easy to download and use)

1. Create and Activate virtual environment

   py -m venv <env-name>

   <env-name>\Scripts\activate.bat

2. Install Package from Pypi

   pip install Dyte-Dependency-version-checker

   [Note : Skip installation from Direct repo if you already installed our package from Pypi]

Usage

3. Help command

   dyte --help

4. Use below command to enter csv file and check dependency version

   dyte check -i <file-name>.csv -d <dependency-name>

   We can also give multiple dependency to check. for example

   dyte check -i <file-name>.csv -d <dependency-name> -d <dependency-name> -d <dependency-name>

   -i = input-file
   -d = depedency-name
   

5. Use below command to enter csv file and update PULL request based on version of dependency

   dyte update -i <file-name>.csv -d <dependency-name>

   We can also give multiple dependency to check. for example

   dyte update -i <file-name>.csv -d <dependency-name> -d <dependency-name> -d <dependency-name>

   update = to create PR if version is not satisfied 
   -i = input-file
   -d = depedency-name
   

Install Directly from Github repo

1. Create and Activate virtual environment

   py -m venv <env-name>

   <env-name>\Scripts\activate.bat

2. Clone the repo

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

3. Install python libraries from requirements.txt

   pip install -r requirements.txt

Usage

4. Use bellow to enter csv file and check dependency version

   python dyte.py check -i <file-name>.csv -d <dependency-name>

   We can also give multiple dependency to check for example

   python dyte.py check -i <file-name>.csv -d <dependency-name> -d <dependency-name> -d <dependency-name>

   -i = input-file
   -d = depedency-name
   

5. Use bellow to enter csv file and update PULL request based on version of dependency

   python dyte.py update -i <file-name>.csv -d <dependency-name>

   We can also give multiple dependency to check for example

   python dyte.py update -i <file-name>.csv -d <dependency-name> -d <dependency-name> -d <dependency-name>

   update = to create PR if version is not satisfied 
   -i = input-file
   -d = depedency-name
   

(back to top)

Usage with output

Exceuting command : dyte check -i input.csv -d axios@0.23.0

OUTPUT

Exceuting command : dyte update -i input.csv -d axios@0.23.0

OUTPUT

(back to top)

See the open issues for a full list of proposed features (and known issues).

(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

Your Name - Harsh Kanani (19BCE2562)- [e-mail]

Project Link: https://github.com/dyte-submissions/dyte-vit-2022-harshkanani014

(back to top)

(back to top)