Feedback

README.md

@@ -21,32 +21,24 @@
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
 [![MIT License][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
+[![LinkedIn][linkedin-shield]](https://www.linkedin.com/in/mokshda-gangrade-753b281b3/)
 
 
 
 <!-- PROJECT LOGO -->
 <br />
 <div align="center">
-  <a href="https://github.com/github_username/repo_name">
-    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  <a href="https://github.com/dyte-submissions/dyte-vit-2022-mokshdagangrade/">
+    <img src="images/pyGithubBot_logo.png" alt="Logo" width="200" height="200">
   </a>
 
-<h3 align="center">project_title</h3>
+<h3 align="center">pyGithubBot</h3>
 
   <p align="center">
-    project_description
+    This is a python tool that automates the process of reviewing repositories from a file and sending pull requests after committing the changes.
     <br />
-    <a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
-    <br />
-    <br />
-    <a href="https://github.com/github_username/repo_name">View Demo</a>
-    ·
-    <a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
-    ·
-    <a href="https://github.com/github_username/repo_name/issues">Request Feature</a>
+
   </p>
 </div>
 
@@ -70,7 +62,6 @@
       </ul>
     </li>
     <li><a href="#usage">Usage</a></li>
-    <li><a href="#roadmap">Roadmap</a></li>
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
     <li><a href="#contact">Contact</a></li>
@@ -83,58 +74,65 @@
 <!-- ABOUT THE PROJECT -->
 ## About The Project
 
-[![Product Name Screen Shot][product-screenshot]](https://example.com)
-
-Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
+This is a Python Command Line Tool that helps to query Github Repositories and find out their versions, as well as update the versions and send a Pull Request to the main branch. This tool can automate the process and in future can be customised to a more personalised tool for specific requests.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
 
 ### Built With
 
-* [Next.js](https://nextjs.org/)
-* [React.js](https://reactjs.org/)
-* [Vue.js](https://vuejs.org/)
-* [Angular](https://angular.io/)
-* [Svelte](https://svelte.dev/)
-* [Laravel](https://laravel.com)
-* [Bootstrap](https://getbootstrap.com)
-* [JQuery](https://jquery.com)
-
+* [Python](https://www.python.org/)
+* [pyGithub](https://github.com/PyGithub/PyGithub)
+* [GitPython](https://github.com/gitpython-developers/GitPython)
+* [Typer](https://typer.tiangolo.com/)
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
 
 <!-- GETTING STARTED -->
 ## 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.
-* npm
-  ```sh
-  npm install npm@latest -g
-  ```
+* Git
+* Python
+* Generate a github personal access token with scopes: repo, admin:org, gist
+* Typer
+```sh
+   pip install typer
+   ```
+* GitPython
+```sh
+   pip install python-git
+   ```
+* pyGithub
+```sh
+   pip install github
+   ```
+* JSON
+```sh
+   pip install json
+   ```
+* OS
+```sh
+   pip install os
+   ```
+* Git
+```sh
+   pip install git
+   ```
+
 
 ### Installation
 
-1. Get a free API Key at [https://example.com](https://example.com)
-2. Clone the repo
-   ```sh
-   git clone https://github.com/github_username/repo_name.git
-   ```
-3. Install NPM packages
+1. Clone the repo
    ```sh
-   npm install
-   ```
-4. Enter your API in `config.js`
-   ```js
-   const API_KEY = 'ENTER YOUR API';
+   git clone https://github.com/dyte-submissions/dyte-vit-2022-mokshdagangrade.git
    ```
+2. Go to the dist folder and there will be pyGithubBot.exe file. In that folder, open cmd. Or go the dist directory from cmd. Then run the commands below. 
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -143,24 +141,51 @@ This is an example of how to list things you need to use the software and how to
 <!-- USAGE EXAMPLES -->
 ## Usage
 
-Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
-
-_For more examples, please refer to the [Documentation](https://example.com)_
-
-<p align="right">(<a href="#top">back to top</a>)</p>
-
-
+There are three commands to enter in the command prompt. A sample input.csv is there in this project.
+1. Get Repository Details of repos in the csv file.
+```sh
+   pyGithubBot repodetails input.csv axios
+   ```
+   <div align="center">
+    <img src="images/repodetails.png" alt="ss" width="700" height="350">
+  </div>
+  <br><br>
+2. Check if the versions of the repos in input file are above the given version. An output file will be generated.
 
-<!-- ROADMAP -->
-## Roadmap
+Command: pyGithubBot info {input file} {os} {version}
 
-- [ ] Feature 1
-- [ ] Feature 2
-- [ ] Feature 3
-    - [ ] Nested Feature
+```sh
+   pyGithubBot info input.csv axios 0.35.0
+   ```
+<br><br>
+3. This will update the versions, commit, push and generate a pull request.  An output file will be generated.
 
-See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
+Command: pyGithubBot update {input file} {os} {version}
 
+```sh
+   pyGithubBot update input.csv axios 0.35.0
+   ```
+   <div align="center">
+    <img src="images/info_update.png" alt="ss" width="700" height="350">
+  </div>
+  <br><br>
+
+  <div align="center">
+    <img src="images/input.png" alt="ss" width="700" height="350">
+  </div>
+  <br><br>
+  <div align="center">
+    <img src="images/output.png" alt="ss" width="700" height="350">
+  </div>
+  <br><br>
+<div align="center">
+    <img src="images/tool_folder.png" alt="ss" width="700" height="350">
+  </div>
+  <br><br>
+<div align="center">
+    <img src="images/pull_request.png" alt="ss" width="700" height="350">
+  </div>
+  <br><br>
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
@@ -195,9 +220,9 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
 <!-- CONTACT -->
 ## Contact
 
-Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
+Your Name - Mokshda Gangrade - mokshdagangrade@gmail.com
 
-Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)
+Project Link: [https://github.com/dyte-submissions/dyte-vit-2022-mokshdagangrade/](https://github.com/dyte-submissions/dyte-vit-2022-mokshdagangrade/)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -206,9 +231,7 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/
 <!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
 
-* []()
-* []()
-* []()
+* Dyte.io Team for giving me this assignment. 
 
 <p align="right">(<a href="#top">back to top</a>)</p>