Depen-Tool

A CLI Tool to check & update dependency versions in Github Repositories
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

About The Project

This is a CLI tool for updating dependencies of Github Repositories.

(back to top)

Built With

• Python
• Node.JS

(back to top)

Getting Started

This is how you may setup this 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.

• npm

  npm install npm@latest -g

The following are some necessary python libraries to be installed.

• python

  pip install PyGithub

  pip install pandas

  pip install argparse

  pip install json

• MAKE SURE THE GITHUB ACCOUNT THAT CONTAINS REPOSITORIES ON WHICH YOU WANT RUN THIS TOOL, IS ALREADY LOGED INTO YOUR TERMINAL
• MAKE SURE YOU CARRY THE GITHUB ACCESS CODE TO THE ABOVE MENTIONED GITHUB ACCOUNT

Installation

1. Get a Github Access Key at Github Access Tokens
2. Create a Folder with any random name
3. Open Terminal in the above mentioned Folder (For easy navigation through output files, that will be genarated later)
4. Clone the repo

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

5. Install NPM packages

   npm install

(back to top)

Usage

Here is a detailed Walkthrough of how one may use this tool.

• Open the folder that contains your SDKtool.exe.

• Run terminal in this folder.

• Create a .csv file containing github repository links in the following manner. Let it be named input.csv.

• Save the input.csv file in the same folder where SDKtool.exe exists

• To check dependencies of github repositories mentioned in input.csv with respect to QueryDependency@RequiredVersion(for example [email protected]) run the following command:

  SDKtool.exe input.csv [email protected]

  OR

  SDKtool.exe input.csv QueryDependency@RequiredVersion

• Running the above command will provide a new output.csv

• To update the dependencies of github repositories which where less than RequiredVersion run the following command:

  SDKtool.exe input.csv [email protected] --update

  OR

  SDKtool.exe input.csv QueryDependency@RequiredVersion --update

• Running the above command will update the dependencies and send a Pull Request to the github repository, create an output file named PROutput.csv

• PR is created in the link given in PROutput.csv

(back to top)

Roadmap

• Check dependency valid or not
• Check dependency version valid or not
• Check deprecation of dependencies
• Clone repositories from CSV file
• Check version satisfiability in each repository
• Create Output File with version & version satisfiability
• Update version of un satisfied dependencies
• Create new Output File with PR links

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 - @SaiChai91235079 - [email protected]

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

(back to top)