Initial Files added

kaustubhgupta · kaustubhgupta · commit 9ad7c7a162e3 · 2021-03-27T13:28:15.000+05:30
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## My Pledge
+
+In the interest of fostering an open and welcoming environment, I as
+contributor and maintainer pledge to making participation in my project and
+my community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity, and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## My Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct that could reasonably be considered inappropriate in a
+ professional setting
+
+## My Responsibilities
+
+The project maintainer is responsible for clarifying the standards of acceptable
+behavior and is expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+The project maintainer has the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by the project maintainer.
+
+## Enforcement
+
+Instances of abusive, harassing or otherwise unacceptable behavior may be
+reported by contacting the project maintainer at [LinkedIn](https://www.linkedin.com/in/kaustubh-gupta). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project maintainer is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainer who does not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# Contributing to PortFolioFy
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+Contributions are always appreciated as **no contribution is too small.**
+**We are here to learn and grow along with the community**
+
+
+# Submitting Contributions
+- **Perfom all the initials:** Fork the repo, clone your version locally, add upstream to my repo `https://github.com/kaustubhgupta/readme-projects-display`, create a new branch. If you're not aware of all these terminologies, there are ton of resources available on internet.
+
+- **Choosing the Issue:** You can create issues for bugs, new features, documentation errors or anything you want to add. Open a new issue and we will have the discussion about it.
+
+- **Local Setup:** Python needs to installed beforehand. Other than this, you should create a new environment for this project and install all the requirements via pip ( `pip install -r requirements.txt`)
+
+
+**Important:** Make sure to check the docs for more detailed descriptions of various parameters and files used.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Kaustubh 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,71 @@
+![readme-projects-display](https://socialify.git.ci/kaustubhgupta/readme-projects-display/image?description=1&font=KoHo&forks=1&issues=1&language=1&owner=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Light) 
+<p align="center">
+<img src="https://img.shields.io/badge/python%20-%2314354C.svg?&style=for-the-badge&logo=python&logoColor=white" align="center">
+<img src="https://img.shields.io/badge/markdown-%23000000.svg?&style=for-the-badge&logo=markdown&logoColor=white" align="center">
+<img src="https://img.shields.io/badge/github%20actions%20-%232671E5.svg?&style=for-the-badge&logo=github%20actions&logoColor=white "align="center">
+</p>
+
+GitHub's Profile readme is a great tool to showcase your skills and projects to potential recruiters/developers. This GitHub action allows you to update a particular section of README with your Project details. These include the project name, stars, and a controllable amount of description. 
+
+<p align="center">
+<img src="./images/preview.png" align="center">
+</p>
+
+## Getting Your Profile Ready
+
+- Add this comment in your README.md/specified file:
+```
+<!-- PROJECTS START -->
+<!-- PROJECTS END -->
+```
+
+- The repositories need to have `project`  topic to add them to the project section.
+
+- A GitHub personal access token will be needed which can be obtained by going to Settings > Developer Settings > Personal Access Tokens.
+  <div align="center"> <img src="./images/config.png" align="center"> </div>
+
+_Note: If you give personal repositories access then they will be added to the sections but their links will not work for others_
+
+
+## Action Setup
+
+GitHub actions can be integrated in any repository. Create a new folder called `.github/workflows/<any-name>.yml`. Paste the following starter code:
+
+```yml
+name: Update Projects
+on:
+  schedule:
+    - cron: '0 0 * * *'
+    # This makes the action to run at the end of every day. Customize this accordingly or you can also trigger this action for GitHub events (Pull, Push). Check the GitHub actions page for that.
+  workflow_dispatch:
+    # workflow_dispatch allows you to trigger the action any time manually
+
+jobs:
+  update-readme-with-projects:
+    name: Update this repo's README with latest project updates
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: kaustubhgupta/readme-projects-display@master
+        with:
+          gh_token: ${{ secrets.TOKEN }} # Create a secret to store the access token 
+```
+
+## Available Options
+_Note: The whole documentation of the action will be updated soon_
+
+| Option         | Default Value | Description                                                                  | Required | Example |
+| -------------- | ------------- | ---------------------------------------------------------------------------- | -------- | ------- |
+| `gh_token`     | NA            | GitHub Personal Access token                                                 | Yes      |  NA     |
+| `file_name`        | `README.md`           | Name of the readme file or any other file containing the comment mentioned above. Note: The file needs to be in root of repository. (Dynamic paths coming in next version!)                                   | No       |  myfile.txt/ myfile.html    | 
+| `max_repo_description` | 50 | How much description you want to Display | No | 40 |
+
+
+## Examples
+- [My Workflow File](https://github.com/kaustubhgupta/kaustubhgupta/blob/master/.github/workflows/updaters.yml)
+
+**Happy?? Do Star ⭐ this Repo. 🤩**
+
+## License
+
+[![MIT Licence](https://img.shields.io/github/license/kaustubhgupta/PortfolioFy)](https://choosealicense.com/licenses/mit/)
diff --git a/action.yml b/action.yml
@@ -9,13 +9,17 @@ inputs:
     description: "Name of the file"
     required: False
     default: README.md
+  max_repo_description:
+    description: "How much description you want to Display"
+    required: False
+    default: 50
 
 runs:
   using: "composite"
   steps:
     - run: python -m pip install PyGithub
       shell: bash
-    - run: python ${{ github.action_path }}/main-script.py ${{ inputs.gh_token }} ${{ inputs.file_name }} ${{ github.workspace }}
+    - run: python ${{ github.action_path }}/main-script.py ${{ inputs.gh_token }} ${{ inputs.file_name }} ${{ github.workspace }} ${{ inputs.max_repo_description }}
       shell: bash
 branding:
   icon: "award"
diff --git a/images/config.png b/images/config.png
diff --git a/images/preview.png b/images/preview.png
diff --git a/main-script.py b/main-script.py
@@ -12,10 +12,9 @@ def rewriteContents(old_content, new_content):
         new_content)
     return r.sub(new_content_formated, old_content)
 
-
-root = pathlib.Path(__file__).parent.resolve()
 git = Github(sys.argv[1])
 start = git.rate_limiting[0]
+max_repo_description = int(sys.argv[4])
 print(f'Request left at start of the script: {start}')
 
 user_object = git.get_user()
@@ -32,7 +31,7 @@ def rewriteContents(old_content, new_content):
         repo_topics = repo_object.get_topics()
         if len(repo_topics) != 0:
             if 'project' in repo_topics:
-                project_data[f'{repo}'] = {'repo_description': repo_object.description if len(repo_object.description) < 50 else repo_object.description[:50] + '...',
+                project_data[f'{repo}'] = {'repo_description': repo_object.description if len(repo_object.description) < max_repo_description else repo_object.description[:max_repo_description] + '...',
                                            'repo_stars': int(repo_object.stargazers_count),
                                            'repo_link': f'https://github.com/{git_username}/{repo}'
                                            }
@@ -70,14 +69,10 @@ def rewriteContents(old_content, new_content):
 
 newContent = ' '.join(newContent)
 rewrittenReadme = rewriteContents(readme, newContent)
-print(repoName)
-print(readme_path)
-print(readme)
-print(readmeRepo)
 print("=====================RESULTS=============================")
 if rewrittenReadme != readme:
     print("Repo Contents Updated")
     readmeRepo.update_file(contents.path, "Updating Projects Section",
                         rewrittenReadme, contents.sha)
 else:
-    print("No change detected in file contents")
+    print("No change detected in file contents")
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+PyGithub==1.53
