Automating dependency check with github

Built With

• Python
• Github api
• Pypi

(back to top)

About the project

Dependency checker made with python and it is also converted in a package for easy installation in linux and macOS environment.

Getting Started

Features

1. Made python package for easy installation of packages in linux.
2. CLI tool implemented.
3. Response saved in csv file.

Prerequisites

1. Python
2. pip
3. virtual environment

Running with python package(converted python file into a package)

1. Open command prompt install package

   Install package command: pip install dependency-checker-dpch
   To install pip in linux: sudo apt install python3-pip

2. Open cmd and write command for executing the file

   dpch --file <csv file name> --dep <dependency to check> --user <github username> --auth <github auth toke> --email <email of your github account> --u <no parameters just wirte it if you need to update the version and create PR>

   example command: dpch --file D:\jevin\dyte-assignment\demo.xlsx --dep morgan@1.10.0  --user jevin925 --auth ghp_EnMy*************3qAAf3SRgt1 --email jevin925@gmail.com --u

   Note: If you are giving only file name in input make sure the file is present in your current directory.

3. Output will be save in file output.csv at your current woking directory.

Running the file manually

1. Clone the repo and cd into dependency checker folder

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

2. Make virtual environment and activate it

   virtual environment command: py -m venv <env name>
   activating command: <env name>\Scripts\activate.bat

3. Install all dependencies from requirements.txt

   install command: pip install -r requirements.txt

4. Run command in terminal

   python <name of file> --file <csv file name> --dep <dependency to check> --user <github username> --auth <github auth toke> --email <email of your github account> --u <no parameters just wirte it if you need to update the version and create PR>

   example command:  python dep_chk.py --file D:\jevin\dyte-assignment\demo.xlsx --dep morgan@1.10.0  --user jevin925 --auth ghp_EnMy*************3qAAf3SRgt1 --email jevin925@gmail.com --u

   Note: If you are giving only file name in input make sure the file is present in your current directory.

5. Output will be save in file output.csv at your current woking directory.

(back to top)

Output

Executing in command line by python package(with update) :

Output file with update command :

Executing in command line by python package(without update) :

Output file without update command :

Contact

Jevin Vekaria - jevn925@gmail.com

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

(back to top)