DependaTroll

Your friendly neighborhood Dependabot clone . Just without the annoying mails and notifications :) Yeah also light weight :-). To get started just type

./Dependatroll --help

Ps : Make sure you see the Installation Section First

Environment Variables

export GITHUB_AUTH_TOKEN="AUTH_TOKEN"

export GITHUB_USERNAME="USERNAME"

Binary Location

dist/DependaTroll

First Version (app.py)

In the First Version of the script ie app.py We have shallow Cloned all the repositories from the CSV file . This is the first version of the script even though it is complete and working . It is not the most optimal way out there as it required extra bandwidth to clone all the repositories. And then use the bash/zsh shell of the host machine to run the script. This was not only time and space intensive but also needed to have certain dependencies like git and github CLI to be installed on the host machine . Which is not the case for most of the people.

WorkFlow For The First Version

• Parse the CLI ARGS
• Raw Content Fetched Using Curl
• For Updates the Repositories Forked Using gh cli
• Then the forked repositories were cloned to a depth == 1 and moved to the folder for JSON File
• Then the corresponding Dependency changes were made and added to List
• Table made using tabulate
• This version had un-necessary dependencies and was not the most optimal way out there

Second Version(appv2.py)

In the second version of the script ie appv2.py We have not cloned any of the repositories completely . Only fetched the package.json file . This method is much more efficient and less bandwidth intensive. As it does not pull the entire repository. As in some cases the repositories would be very large . Thus eliminating the network overhead of cloning the repository.Could save both time and money .

It is for the same reason of performance that I have not used libraries such as pandas for csv manipulation as the storage overhead might overway the cost .

Workflow for the Second Version

• Parse the CLI ARGS
• Json file fetched Using PyGithub GetContent allowing us to fetch only one file
• Made changes in package.json
• Tabulate the changes using tabulate
• Forking the repository achieved by PyGithub
• Creating a new Branch For every Dependancy Update
• Creating Pull Request and Fetching URL for that Request to Append to the Table

Screenshots

For checking unmet dependencies .



For Updating dependencies



Final Table After Updations



Run Locally

Clone the project

  https://github.com/NimeshJohari02/DependaTroll.git

Go to the project directory

  cd DependaTroll/

Install dependencies

    pip install -r requirements.txt

Usage/Examples

1. Move to the Directory Of Executable file cd dist
2. To make executable use chmod +x DependaTroll
3. Before running the executable make sure you have exported the API key export GITHUB_AUTH_TOKEN=YOUR_AUTH_TOKEN export GITHUB_USERNAME=YOUR_GITHUB_USERNAME

# To check for unmet dependencies use the following command

DependaTroll -i Dataset.csv axios@0.24.012 node@16.2 react@16.6 ejs@12.1

#Add any number of Libraries and Versions Seperated by " " and Versions by "@"





# To check for updation of the unmet dependencies use the following command

DependaTroll -u true -i Dataset.csv axios@0.24.012 node@16.2 react@16.6 ejs@12.1

#Add any number of Libraries and Versions Seperated by " " and Versions by "@"

Output For updating the dependencies





Updated dependencies look like these



Pull Request Once Created Can Also be seen from Github



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)

Contact

Nimesh Kumar Johari - @github - nimeshjohari95@gmail.com

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

(back to top)

Badges