[
{
"path": ".github/CHANGE_LOG.md",
"content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\n## [Unreleased]\n\n\n\nUpcoming changes.\n\n### Added\n\n### Changed\n\n### Removed\n\n## [0.0.1] - YYYY-MM-DD\n\nInitial Release.\n\n### Added\n\n- What was added.\n\n\n\n[Unreleased]: /\n[0.0.1]: /v0.0.1\n"
},
{
"path": ".github/CODEOWNERS",
"content": "# These owners will be the default owners for everything in\n# the repo. Unless a later match takes precedence,\n# @MarketingPip will be requested for\n# review when someone opens a pull request.\n# if you want to add more owners just write it after the demo user @OctoCat\n* @MarketingPip\n"
},
{
"path": ".github/CODE_OF_CONDUCT.md",
"content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\nthe following e-mail address example@hello.com.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n"
},
{
"path": ".github/CONTRIBUTING.md",
"content": "# Contributing\n\nThere are a lot of different ways to contribute to this project. See below for\neverything you can do and the processes to follow for each contribution method.\nNote that no matter how you contribute, your participation is governed by our\n[Code of Conduct](CODE_OF_CONDUCT.md).\n\n## Make changes to the code or docs\n\nFork the project, make a change, and send a pull request! \n\nMake sure you read and follow the instructions in the [pull request template](.github/pull_request_template.md). And note\nthat all participation in this project (including code submissions) is\ngoverned by our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## Submit bug reports or feature requests\n\nJust use the GitHub issue tracker to submit your bug reports and feature\nrequests. \n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.yaml",
"content": "name: Bug Report\ndescription: File a bug report\ntitle: \"[Bug]: \"\nlabels: [\"bug\", \"triage\"]\nassignees:\n - octocat\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for taking the time to fill out this bug report!\n - type: input\n id: contact\n attributes:\n label: Contact Details\n description: How can we get in touch with you if we need more info?\n placeholder: ex. email@example.com\n validations:\n required: false\n - type: textarea\n id: what-happened\n attributes:\n label: What happened?\n description: Describe the issue here.\n placeholder: Tell us what you see!\n value: \"A bug happened!\"\n validations:\n required: true\n - type: dropdown\n id: browsers\n attributes:\n label: What type of browser are you seeing the problem on?\n multiple: true\n options:\n - Firefox\n - Chrome\n - Safari\n - Microsoft Edge\n validations:\n required: true\n\n - type: dropdown\n id: operating-systems\n attributes:\n label: What type of Operating System are you seeing the problem on?\n multiple: true\n options:\n - Linux\n - Windows\n - Mac\n - Other\n validations:\n required: true\n \n\n - type: textarea\n id: logs\n attributes:\n label: Code to produce this issue.\n description: Please copy and paste any relevant code to re-produce this issue. And the version of the browser you are using. \n render: shell\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.yaml",
"content": "name: Feature request\ndescription: Suggest an feature / idea for this project\ntitle: \"[Feature Request / Suggestion]: \"\nlabels: [\"enhancement\"]\nbody:\n - type: markdown\n attributes:\n value: |\n We appreciate your feedback on how to improve this project. Please be sure to include as much details & any resources if possible!\n - type: textarea\n id: Suggestion\n attributes:\n label: Suggestion / Feature Request\n description: Describe the feature(s) you would like to see added.\n placeholder: Tell us your suggestion\n value: \"Your suggestion here\"\n validations:\n required: true\n \n"
},
{
"path": ".github/SECURITY.md",
"content": "# Security Policy\n\n## Supported Versions\n\n| Version | Supported |\n| ------- | ------------------ |\n| 5.1.x | :white_check_mark: |\n| 5.0.x | :x: |\n| 4.0.x | :white_check_mark: |\n| < 4.0 | :x: |\n\n## Reporting a Vulnerability\n\nIf you have identified a security vulnerability in system or product please email `example@hello.com` with your findings. We strongly recommend using our `PGP key` to prevent this information from falling into the wrong hands.\n\n### Disclosure Policy\n\nUpon receipt of a security report the following steps will be taken:\n\n- Acknowledge your report within 48 hours, and provide a further more detailed update within 48 hours.\n- Confirm the problem and determine the affected versions\n- Keep you informed of the progress towards resolving the problem and notify you when the vulnerability has been fixed.\n- Audit code to find any potential similar problems.\n- Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible.\n- Handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission.\n\nWhilst the issue is under investigation\n\n- **Do** provide as much information as possible.\n- **Do not** exploit of the vulnerability or problem you have discovered.\n- **Do not** reveal the problem to others until it has been resolved.\n"
},
{
"path": ".github/TO_DO.md",
"content": "# To-Do\n\n## Tasks (Sorted by Priority) \n\n\n#### High\n\n- [ ] Demo Task\n- [ ] Demo Task\n- [ ] Demo Task\n - [ ] Demo Sub-Task\n - [ ] Demo Sub-Task\n\n\n#### Medium\n\n- [ ] Demo Task\n- [ ] Demo Task\n- [ ] Demo Task\n - [ ] Demo Sub-Task\n - [ ] Demo Sub-Task\n\n#### Low\n\n- [ ] Demo Task\n- [ ] Demo Task\n- [ ] Demo Task\n - [ ] Demo Sub-Task\n - [ ] Demo Sub-Task\n"
},
{
"path": ".github/config.yml",
"content": "# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome\n\n# Comment to be posted to on first time issues\nnewIssueWelcomeComment: >\n Thanks for opening your first issue! Reports like these help improve the project!\n\n# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome\n\n# Comment to be posted to on PRs from first time contributors in your repository\nnewPRWelcomeComment: >\n Thanks for opening this pull request! \n\n# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge\n\n# Comment to be posted to on pull requests merged by a first time user\nfirstPRMergeComment: >\n Congrats on merging your first pull request!\n\n# The keyword to find for Todo Bot issue\ntodo:\n keyword: '@todo'\n"
},
{
"path": ".github/issue_label_bot.yaml",
"content": "label-alias:\n bug: 'Type: Bug'\n feature_request: 'Type: Feature'\n question: 'Type: Question'\n"
},
{
"path": ".github/pull_request_template.md",
"content": "## Proposed changes\n\nDescribe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.\n\n## Types of changes\n\nWhat types of changes does your code introduce to this project?\n_Put an `x` in the boxes that apply_\n\n- [ ] Bugfix (non-breaking change which fixes an issue)\n- [ ] New feature (non-breaking change which adds functionality)\n- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)\n- [ ] Documentation Update (if none of the other choices apply)\n\n## Checklist\n\n_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._\n\n- [ ] I have read the CONTRIBUTING.md\n- [ ] I have added tests that prove my fix is effective or that my feature works\n- [ ] I have added necessary documentation (if appropriate)\n\n## Further comments\n\nIf this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...\n"
},
{
"path": ".github/py_repo_tools/generate_index_file.py",
"content": "#! /usr/bin/env python\n# -*- coding: utf-8 -*-\n\n\nimport sys\nimport os\nimport codecs\nimport urllib.request, json \n\n\n\n\n\nAPI_URL = os.environ['INPUT_STORE']\n \t\n\nwith urllib.request.urlopen(f\"{API_URL}\") as url:\n data = json.loads(url.read().decode())\n SiteDescription = data['description']\n SiteTitle = data['name']\n Author = data['owner']['login']\n \n\n\n\n# README File Path\ninput_file = \"README.md\"\ninput_file_contents = None\n\n# Open our README file \ntry:\n with open(input_file, 'r') as f:\n input_file_contents = f.read()\n \nexcept IOError:\n sys.exit('README.md file does not exist, or has no content. Exiting')\n\n\noutput_file = \"index.html\"\n\n# Write out the Index.HTML file \ntry:\n with codecs.open(output_file, 'w', encoding='utf-8') as f:\n f.write(f\"\"\"{SiteTitle}\n\t\n\t\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\t \n\t \n \n \"\"\" + \"\"\"\n\n\n\n\"\"\" + \n\n input_file_contents + \"\"\"\n \n\t\n\t \n\t\"\"\")\nexcept IOError:\n sys.exit(u'Unable to write to file: {0}'.format(output_file))\n"
},
{
"path": ".github/py_repo_tools/replace_code_of_conduct_info.py",
"content": "\nimport json\n \n# Opening JSON file\nf = open('.github/py_repo_tools/repo_config.json')\n \n# returns JSON object as \n# a dictionary\nconfig = json.load(f)\n \n\n# Define the filename here you want to replace content in\nFileName = \".github/CODE_OF_CONDUCT.md\"\n\n# Replace with string\nText_To_Replace = \"example@hello.com\"\n\n# Replace with JSON value\nText_To_Replace_With = config['EMAIL']\n\n# Closing file\nf.close()\n\n\n# Open the File\nwith open(FileName, 'r') as f:\n # Read the file contents\n contents = f.read()\n # Replace the file contents\n contents = contents.replace(Text_To_Replace, Text_To_Replace_With)\n\n# Write the file out \nwith open(FileName, 'w') as f:\n # Write the updated contents\n f.write(contents) \n"
},
{
"path": ".github/py_repo_tools/replace_repo_links.py",
"content": "# Python program to read\n# json file\n \n \nimport json\n \n# Opening JSON file\nf = open('.github/py_repo_tools/repo_config.json')\n \n# returns JSON object as \n# a dictionary\nconfig = json.load(f)\n \n\n# Define the filename here you want to replace content in\nFileName = \"README.md\"\n\nText_To_Replace = config['Text_To_Replace']\n\nText_To_Replace_With = config['Text_To_Replace_With']\n\n# Closing file\nf.close()\n\n\n# Open the File\nwith open(FileName, 'r') as f:\n # Read the file contents\n contents = f.read()\n # Replace the file contents\n contents = contents.replace(Text_To_Replace, Text_To_Replace_With)\n\n# Write the file out \nwith open(FileName, 'w') as f:\n # Write the updated contents\n f.write(contents) \n"
},
{
"path": ".github/py_repo_tools/replace_security_policy_email.py",
"content": "\nimport json\n \n# Opening JSON file\nf = open('.github/py_repo_tools/repo_config.json')\n \n# returns JSON object as \n# a dictionary\nconfig = json.load(f)\n \n\n# Define the filename here you want to replace content in\nFileName = \".github/SECURITY.md\"\n\n# Replace with string\nText_To_Replace = \"example@hello.com\"\n\n# Replace with JSON value\nText_To_Replace_With = config['EMAIL']\n\n# Closing file\nf.close()\n\n\n# Open the File\nwith open(FileName, 'r') as f:\n # Read the file contents\n contents = f.read()\n # Replace the file contents\n contents = contents.replace(Text_To_Replace, Text_To_Replace_With)\n\n# Write the file out \nwith open(FileName, 'w') as f:\n # Write the updated contents\n f.write(contents) \n"
},
{
"path": ".github/py_repo_tools/repo_config.json",
"content": "{\"Text_To_Replace\": \"MarketingPipeline/Awesome-Repo-Template\", \"Text_To_Replace_With\": \"YOUR_GITHUB_USERNAME/Your-Repo-Name\", \"EMAIL\" : \"test@example.com\"}\n"
},
{
"path": ".github/py_repo_tools/shell_scripts/github_downloader.sh",
"content": "\n#!/bin/bash\n#####################################################\n# Download Specific folders from Github using SVN\n# \n# Author: Declan Cook\n# Licence: MIT\n#####################################################\nGHDOMAIN=\"https://github.com/\"\nIN=$1\nIN=${IN##$GHDOMAIN}\nBRANCH=\"trunk\"\nFOLDER=\"\"\nIFS=\"/\" read -a SECT <<< \"$IN\" \n\nif [[ \"${SECT[3]}\" != \"master\" ]]; then\n BRANCH=${SECT[3]}\nfi\nfor index in \"${!SECT[@]}\"; do\n if [ $index -gt 3 ]; then\n FOLDER=$FOLDER/${SECT[index]}\n fi\ndone\n\n# DOMAIN/USER/PROJECT//FOLDER\necho Exporting $GHDOMAIN${SECT[0]}/${SECT[1]}/$BRANCH$FOLDER\nsvn --force export $GHDOMAIN${SECT[0]}/${SECT[1]}/$BRANCH$FOLDER ./\n"
},
{
"path": ".github/settings.yml",
"content": "repository:\n # See https://developer.github.com/v3/repos/#edit for all available settings.\n\n # The name of the repository. Changing this will rename the repository\n #name: repo-name\n\n # A short description of the repository that will show up on GitHub\n #description: description of repo\n\n # A URL with more information about the repository\n #homepage: https://example.github.io/\n\n # A comma-separated list of topics to set on the repository\n #topics: project, template, project-template\n\n # Either `true` to make the repository private, or `false` to make it public.\n #private: false\n\n # Either `true` to enable issues for this repository, `false` to disable them.\n #has_issues: true\n\n # Either `true` to enable the wiki for this repository, `false` to disable it.\n #has_wiki: true\n\n # Either `true` to enable downloads for this repository, `false` to disable them.\n #has_downloads: true\n\n # Updates the default branch for this repository.\n #default_branch: master\n\n # Either `true` to allow squash-merging pull requests, or `false` to prevent\n # squash-merging.\n #allow_squash_merge: true\n\n # Either `true` to allow merging pull requests with a merge commit, or `false`\n # to prevent merging pull requests with merge commits.\n #allow_merge_commit: true\n\n # Either `true` to allow rebase-merging pull requests, or `false` to prevent\n # rebase-merging.\n #allow_rebase_merge: true\n\n# Labels: define labels for Issues and Pull Requests\nlabels:\n - name: 'Type: Bug'\n color: e80c0c\n description: Something isn't working as expected.\n\n - name: 'Type: Enhancement'\n color: 54b2ff\n description: Suggest an improvement for an existing feature.\n\n - name: 'Type: Feature'\n color: 54b2ff\n description: Suggest a new feature.\n\n - name: 'Type: Security'\n color: fbff00\n description: A problem or enhancement related to a security issue.\n\n - name: 'Type: Question'\n color: 9309ab\n description: Request for information.\n\n - name: 'Type: Test'\n color: ce54e3\n description: A problem or enhancement related to a test.\n\n - name: 'Status: Awaiting Review'\n color: 24d15d\n description: Ready for review.\n\n - name: 'Status: WIP'\n color: 07b340\n description: Currently being worked on.\n\n - name: 'Status: Waiting'\n color: 38C968\n description: Waiting on something else to be ready.\n\n - name: 'Status: Stale'\n color: 66b38a\n description: Has had no activity for some time.\n\n - name: 'Duplicate'\n color: EB862D\n description: Duplicate of another issue.\n\n - name: 'Invalid'\n color: faef50\n description: This issue doesn't seem right.\n\n - name: 'Priority: High +'\n color: ff008c\n description: Task is considered higher-priority.\n\n - name: 'Priority: Low -'\n color: 690a34\n description: Task is considered lower-priority.\n\n - name: 'Documentation'\n color: 2fbceb\n description: An issue/change with the documentation.\n\n - name: \"Won't fix\"\n color: C8D9E6\n description: Reported issue is working as intended.\n\n - name: '3rd party issue'\n color: e88707\n description: This issue might be caused by a 3rd party script/package/other reasons\n\n - name: 'Os: Windows'\n color: AEB1C2\n description: Is Windows-specific\n\n - name: 'Os: Mac'\n color: AEB1C2\n description: Is Mac-specific\n\n - name: 'Os: Linux'\n color: AEB1C2\n description: Is Linux-specific\n# # Collaborators: give specific users access to this repository.\n# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options\n# collaborators:\n# # - username: bkeepers\n# # permission: push\n# # - username: hubot\n# # permission: pull\n\n# # Note: `permission` is only valid on organization-owned repositories.\n# # The permission to grant the collaborator. Can be one of:\n# # * `pull` - can pull, but not push to or administer this repository.\n# # * `push` - can pull and push, but not administer this repository.\n# # * `admin` - can pull, push and administer this repository.\n# # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.\n# # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.\n\n# # See https://developer.github.com/v3/teams/#add-or-update-team-repository for available options\n# teams:\n# - name: core\n# # The permission to grant the team. Can be one of:\n# # * `pull` - can pull, but not push to or administer this repository.\n# # * `push` - can pull and push, but not administer this repository.\n# # * `admin` - can pull, push and administer this repository.\n# # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.\n# # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.\n# permission: admin\n# - name: docs\n# permission: push\n\n# branches:\n# - name: master\n# # https://developer.github.com/v3/repos/branches/#update-branch-protection\n# # Branch Protection settings. Set to null to disable\n# protection:\n# # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.\n# required_pull_request_reviews:\n# # The number of approvals required. (1-6)\n# required_approving_review_count: 1\n# # Dismiss approved reviews automatically when a new commit is pushed.\n# dismiss_stale_reviews: true\n# # Blocks merge until code owners have reviewed.\n# require_code_owner_reviews: true\n# # Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.\n# dismissal_restrictions:\n# users: []\n# teams: []\n# # Required. Require status checks to pass before merging. Set to null to disable\n# required_status_checks:\n# # Required. Require branches to be up to date before merging.\n# strict: true\n# # Required. The list of status checks to require in order to merge into this branch\n# contexts: []\n# # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.\n# enforce_admins: true\n# # Prevent merge commits from being pushed to matching branches\n# required_linear_history: true\n# # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.\n# restrictions:\n# apps: []\n# users: []\n# teams: []\n"
},
{
"path": ".github/workflows/Repo-Generator.yaml",
"content": "name: Repo Generator\n\non:\n workflow_dispatch:\n inputs:\n Replace_Links_In_Markdown:\n description: 'Update all links'\n type: boolean\n required: false\n Update_Code_Of_Conduct_EMAIL:\n description: 'Update Code Of Conduct Email'\n type: boolean\n required: false\n Update_Security_Policy_EMAIL:\n description: 'Update Security Policy Email'\n type: boolean\n required: false\n Compress_Images:\n description: 'Compress / Optimize Images'\n type: boolean\n required: false \n Generate_Table_Of_Contents:\n description: 'Generate Table Of Contents'\n type: boolean\n required: false\n Generate_Metrics_File:\n description: 'Generate Metrics Image File'\n type: boolean\n required: false\n Generate_Index_File:\n description: 'Generate Index File'\n type: boolean\n required: false\n Download_Files_Or_Folder:\n description: 'Download a file or folder from a GitHub Repo'\n required: False\n default: ''\n\njobs:\n Repo_Builder:\n name: Repo Template Builder\n runs-on: ubuntu-20.04\n steps:\n - uses: actions/checkout@v2 \n ### Update links in README file\n - name: Updating links in README content\n if: ${{ github.event.inputs.Replace_Links_In_Markdown == 'true' }}\n run: |\n sudo apt-get install python3\n python3 .github/py_repo_tools/replace_repo_links.py\n \n \n ### Metric Images\n \n - name: Generating Metrics Image\n if: ${{ github.event.inputs.Generate_Metrics_File == 'true' }}\n uses: lowlighter/metrics@v3.24\n with:\n filename: stargazers-metrics.svg\n filepath: /.github/\n plugin_stargazers_charts_type: chartist\n token: ${{ secrets.METRICS_TOKEN }}\n \n \n \n base: \"\"\n \n config_octicon: yes\n \n plugin_stargazers: yes\n plugin_contributors: yes\n \n\n ## - name: Move Metrics Image\n \n # if: ${{ github.event.inputs.Generate_Metrics_File == 'true' }}\n \n # run: |\n # git mv -f ~/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/metrics.plugin.stargazers.svg ~/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/.github\n \n\n ### Table Of Contents \n - name: Generating Table Of Contents\n if: ${{ github.event.inputs.Generate_Table_Of_Contents == 'true' }}\n run: |\n npx markdown-toc-gen update README.md \n\n\n ### Generate Index File \n - name: Generating Index File\n if: ${{ github.event.inputs.Generate_Index_File == 'true' }}\n run: |\n sudo apt-get install python3 \n INPUT_STORE=${{ github.event.repository.url }} python3 .github/py_repo_tools/generate_index_file.py\n \n\n\n ### Optimize / Compress Image \n - name: Optimizing Images\n if: ${{ github.event.inputs.Compress_Images == 'true' }}\n run: |\n sudo apt-get install python3 python3-pip\n pip3 install pillow optimize-images\n optimize-images ./ \n ### Replace COC E-mail \n - name: Updating Code Of Conduct E-Mail\n if: ${{ github.event.inputs.Update_Code_Of_Conduct_EMAIL == 'true' }}\n run: |\n sudo apt-get install python3\n python3 .github/py_repo_tools/replace_code_of_conduct_info.py\n \n ### Replace Security Policy E-mail \n - name: Updating Security Policy E-Mail\n if: ${{ github.event.inputs.Update_Security_Policy_EMAIL == 'true' }}\n run: |\n sudo apt-get install python3\n python3 .github/py_repo_tools/replace_security_policy_email.py \n \n \n ### Download a file or folder from a GitHub repo \n - name: Downloading file / folder from GitHub Repo\n if: ${{ github.event.inputs.Download_Files_Or_Folder != ''}}\n run: |\n chmod +x .github/py_repo_tools/shell_scripts/github_downloader.sh\n .github/py_repo_tools/shell_scripts/github_downloader.sh ${{ github.event.inputs.Download_Files_Or_Folder}} \n \n\n \n ### Commit updates (if any)\n - name: Commiting updates\n run: |\n git config --global user.name \"github-actions[bot]\"\n git config --global user.email \"41898282+github-actions[bot]@users.noreply.github.com\"\n git add -A\n git commit -m \"Updated Content\"\n git push\n"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) 2022 Marketing Pipeline\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.md",
"content": "# Awesome-Repo-Template [](https://github.com/MarketingPipeline/Awesome-Repo-Template/)\n\n\n![\"Repo](\"https://capsule-render.vercel.app/api?type=waving&color=c4a2bd&height=300§ion=header&text=Awesome%20Repo%-Template&fontSize=70&fontColor=ffffff&animation=fadeIn&fontAlignY=38&desc=Easily%20setup%20your%20next%20repo!&descAlignY=60&descAlign=50\")
\n\n\n A awesome repo template to kick-start your next project\n\n
\n Show your support! \n
\n \n ![](\"https://img.shields.io/github/stars/MarketingPipeline/Awesome-Repo-Template.svg?style=social&label=Star\" "\\"Star")
\n \n \n ![](\"https://img.shields.io/github/forks/MarketingPipeline/Awesome-Repo-Template.svg?style=social&label=Fork\" "\\"Fork")
\n \n
\n\n\n## Features:\n\n- A configurable workflow action to: \n - update all links with your own with EASE!\n - update Code Of Conduct E-mail with your own!\n - update Security Policy E-mail with your own!\n - download files & folder from another GitHub Repo\n - compress / optimize all images in repo!\n - generate a Markdown styled [index file](index.html) with SEO details!\n - generate a table of contents in your README\n - generate a star-gazer metrics SVG image\n- Time Saving Files:\n - [Pull request template](.github/pull_request_template.md)\n - Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and\n [feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml)\n - [Contributor guidelines](.github/CONTRIBUTING.md)\n - [Code Owners](.github/CODEOWNERS)\n - [Code of Conduct](.github/CODE_OF_CONDUCT.md)\n - [Change-log](.github/CHANGE_LOG.md)\n - [To-Do list](.github/TO_DO.md)\n - [Security Policy](.github/SECURITY.md)\n - [README](README.md)\n - [License file](LICENSE) \n - GitHub Bot Files\n - [config.yml](/.github/config.yml) file to modify multiple bot's behaviours.\n - [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the issue adder GitHub bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).\n - [settings.yml](/.github/settings.yml) file to use the popular settings GitHub bot. [Activate it or check its documentation](https://probot.github.io/apps/settings/).\n\n\n\n## Example and Usage\n\n\n\n\n\t\n
\nHow to use this template:
\n
\t\t\n \n To run any of these tasks you MUST be in the Actions section\n \n How to find the Action
\n \n  \n\n
\t \n
\t \n\t\nHow to replace all links with your own:
\n
\t\n\t\nEdit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for \"REPLACE_TEXT_WITH\" - to your username & repo name like the following example \n\n MyUserName/My-Repo-Name\n\nAnd run the Repo Generator in Actions - set \"Update all links\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to replace e-mail in Code of Conduct with your own:
\n
\t\n\t\nEdit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for \"EMAIL\" - to your e-mail address like the following example. \n\n hello_world@github.com\n\nAnd run the Repo Generator in Actions- set \"Update Code Of Conduct Info\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to replace e-mail in Security Policy with your own:
\n
\t\n\t\nEdit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for \"EMAIL\" - to your e-mail address like the following example. \n\n hello_world@github.com\n\nAnd run the Repo Generator in Actions- set \"Update Security Info\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to download file(s) / folder(s) from another GitHub repo
\n
\t\n\t\n
\n WARNING
\nfiles downloaded from a repo containing the same name in your current repo will be OVER-WRITTEN.\n
\n\t\nIn the Repo Generator Actions- set \"Download a file or folder from a GitHub Repo\" to a GitHub file path or folder.\n\n\nExample(s)\n\n\nTo download a single file:\n\n https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/README.md\n\n\nTo download a specific folder:\n\n https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/Folder-Name\n \n \n\nTo download all files in a repo folder:\n\n https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/\n \n \n\nNote: File's will be placed into main repo path. \n\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to generate a index.html file
\n
\t\n\t\n\t\nA index.html file will be produced from your README content.\n\nSEO details such as Title, Description & OG images etc are auto-produced using your Repo details.\n\nNote Your README content will be rendered in Github Flavored Markdown using our tool [Markdown-Tag: Add Markdown to any HTML using a tag](https://github.com/MarketingPipeline/Markdown-Tag)\n\nGo to the Repo Generator in Actions- set \"Generate Index File\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to compress / optimize images in repo
\n
\t\n\t\nNote: All images in repo will be compressed / optimized (SVG's are NOT supported)\n\nGo to the Repo Generator in Actions- set \"Compress / Optimize Images\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t\t\n \n\t\n
\t \n
\t \n\t\nHow to generate Table Of Contents:
\n
\t\nTo generate tables of contents automatically use anywhere in your README.md file a comment like so\n\n \n<!-- toc -->\n\n<!-- tocstop -->\n\n\nAnd when running the Repo Generator in Actions - set \"Generate Table Of Contents\" to checked\n\n\nWARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems. \n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t\t\n \n\t\n
\t \n
\t \n\t\nHow to Generate a Metrics Image:
\n
\t\n \nCreate a Personal Access Token & create a repo secret called \"METRICS_TOKEN\" & when running the Repo Generator - set \"Generate Metrics Image File\" to checked \n\nYou will have an image generated that looks like this!\n\n![](\"stargazers-metrics.svg\")
\n\nIt will be placed in the main repo under the filename stargazers-metrics.svg \n\nNote: if someone knows how to change this please make a pull request with the image placed to .github folder!\n\n\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\t\n
\t \n\t\nShield.io Buttons:
\n
\n\n\n\n_Repo metadata_\n\n\t\n[![Github license](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template.svg \"Github license\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE)\n[![Open issues](https://img.shields.io/github/issues/MarketingPipeline/Awesome-Repo-Template.svg \"Open issues\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues)\n[![Closed issues](https://img.shields.io/github/issues-closed/MarketingPipeline/Awesome-Repo-Template.svg \"Closed issues\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed)\n[![Open Pull Requests](https://img.shields.io/github/issues-pr/MarketingPipeline/Awesome-Repo-Template.svg \"Open Pull Requests\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls)\n[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/MarketingPipeline/Awesome-Repo-Template.svg \"Closed Pull Requests\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/MarketingPipeline/Awesome-Repo-Template.svg \"Commit activity\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity)\n[![GitHub contributors](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template.svg \"Github contributors\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors)\n[![Last commit](https://img.shields.io/github/last-commit/MarketingPipeline/Awesome-Repo-Template.svg \"Last commit\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master)\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/)\n\n\n\n_Social buttons_\n\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template \"Go to GitHub repo\")\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template)\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template)\n\n\n\n_Call-to-Action buttons_\n\n\n\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate)\n\n[](https://marketingpip.github.io/Awesome-Repo-Template/)\n\n\n_Documentation button_\n\n\n[](/README.MD \"Go to project documentation\")\n\n\n_Custom button_\n\n![\"Custom](\"https://img.shields.io/badge/Custom-Button-blue.svg?style=flat-square\")
\t\n\n\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n\t \n\nAuto Generated Table Of Contents Demo:
\n
\n\n\n- [Features:](#features)\n- [Example and Usage](#example-and-usage)\n- [Contributing  ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a)\n- [License  ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)\n\n\n\n
\t \n\n How to setup GitHub bots
\n\n
\nThese are bots that are prepared and configured for this template. They need to be activated to properly work.\n\n
\n
\n\n1. The `issue_label_bot.yaml` file depends on the **issue label bot** [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot)(✓ highly recommended).\n2. The `settings.yml` file depends on the **settings label bot** [Activate it or check its documentation](https://probot.github.io/apps/settings/) (optional).\n3. The `config.yml` file depends on the bot **welcome bot** [Activate it or check its documentation](https://probot.github.io/apps/welcome/) and [to-do bot](https://probot.github.io/apps/todo/) (optional).\n\n \n\n\n\n\n\n## Contributing  \n\nWant to improve this template? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome repo template!\n\nSee also the list of\n[contributors](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) who\nparticipate in this project.\n\n## License  \n\nThis project is licensed under the MIT License - see the\n[LICENSE.md](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/main/LICENSE) file for\ndetails.\n\n\n\n\n"
},
{
"path": "index.html",
"content": "Awesome-Repo-Template\n\t\n\t\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\t \n\t \n \n \n\n\n\n# Awesome-Repo-Template [](https://github.com/MarketingPipeline/Awesome-Repo-Template/)\n\n\n![\"Repo](\"https://capsule-render.vercel.app/api?type=waving&color=c4a2bd&height=300§ion=header&text=Awesome%Repo%-Template&fontSize=70&fontColor=ffffff&animation=fadeIn&fontAlignY=38&desc=Easily%20setup%20your%20next%20repo!&descAlignY=60&descAlign=50\")
\n\n\n A awesome repo template to kick-start your next project\n\n
\n Show your support! \n
\n \n \n \n \n \n \n
\n\n\n## Features:\n\n- A configurable workflow action to: \n - update all links with your own with EASE!\n - update Code Of Conduct E-mail with your own!\n - update Security Policy E-mail with your own!\n - compress / optimize all images in repo!\n - generate a Markdown styled [index file](index.html) with SEO details!\n - generate a table of contents in your README\n - generate a star-gazer metrics SVG image\n- Time Saving Files:\n - [Pull request template](.github/pull_request_template.md)\n - Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and\n [feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml)\n - [Contributor guidelines](CONTRIBUTING.md)\n - [Code of Conduct](CODE_OF_CONDUCT.md)\n - [Change-log](.github/CHANGE_LOG.md)\n - [To-Do list](.github/TO_DO.md)\n - [Security Policy](.github/SECURITY.md)\n - [README](README.md)\n - [License file](LICENSE) \n\n\n\n\n## Example and Usage\n\n\n\n\n\t\n
\nHow to use this template:
\n
\t\t\n \n To run any of these tasks you MUST be in the Actions section\n \n How to find the Action
\n \n  \n\n
\t \n
\t \n\t\nHow to replace all links with your own:
\n
\t\n\t\nEdit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for \"REPLACE_TEXT_WITH\" - to your username & repo name like the following example \n\n MyUserName/My-Repo-Name\n\nAnd run the Repo Generator in Actions - set \"Update all links\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to replace e-mail in Code of Conduct with your own:
\n
\t\n\t\nEdit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for \"EMAIL\" - to your e-mail address like the following example. \n\n hello_world@github.com\n\nAnd run the Repo Generator in Actions- set \"Update Code Of Conduct Info\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\t\nHow to replace e-mail in Security Policy with your own:
\n
\t\n\t\nEdit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for \"EMAIL\" - to your e-mail address like the following example. \n\n hello_world@github.com\n\nAnd run the Repo Generator in Actions- set \"Update Security Info\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n
\t \n\n
\t \n
\t \n\t\nHow to compress / optimize images in repo
\n
\t\n\t\nNote: All images in repo will be compressed / optimized (SVG's are NOT supported)\n\nGo to the Repo Generator in Actions- set \"Compress / Optimize Images\" to checked\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t\t\n \n\t\n
\t \n
\t \n\t\nHow to generate Table Of Contents:
\n
\t\nTo generate tables of contents automatically use anywhere in your README.md file a comment like so\n\n \n<!-- toc -->\n\n<!-- tocstop -->\n\n\nAnd when running the Repo Generator in Actions - set \"Generate Table Of Contents\" to checked\n\n\nWARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems. \n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t\t\n \n\t\n
\t \n
\t \n\t\nHow to Generate a Metrics Image:
\n
\t\n \nCreate a Personal Access Token & create a repo secret called \"METRICS_TOKEN\" & when running the Repo Generator - set \"Generate Metrics Image File\" to checked \n\nYou will have an image generated that looks like this!\n\n\n\nIt will be placed in the main repo under the filename stargazers-metrics.svg \n\nNote: if someone knows how to change this please make a pull request with the image placed to .github folder!\n\n\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\t\n
\t \n\t\nShield.io Buttons:
\n
\n\n\n\n_Repo metadata_\n\n\t\n[![Github license](https://img.shields.io/github/license/MarketingPipeline/Awesome-Repo-Template.svg \"Github license\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE)\n[![Open issues](https://img.shields.io/github/issues/MarketingPipeline/Awesome-Repo-Template.svg \"Open issues\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues)\n[![Closed issues](https://img.shields.io/github/issues-closed/MarketingPipeline/Awesome-Repo-Template.svg \"Closed issues\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed)\n[![Open Pull Requests](https://img.shields.io/github/issues-pr/MarketingPipeline/Awesome-Repo-Template.svg \"Open Pull Requests\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls)\n[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed/MarketingPipeline/Awesome-Repo-Template.svg \"Closed Pull Requests\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/MarketingPipeline/Awesome-Repo-Template.svg \"Commit activity\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity)\n[![GitHub contributors](https://img.shields.io/github/contributors/MarketingPipeline/Awesome-Repo-Template.svg \"Github contributors\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors)\n[![Last commit](https://img.shields.io/github/last-commit/MarketingPipeline/Awesome-Repo-Template.svg \"Last commit\")](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master)\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/)\n\n\n\n_Social buttons_\n\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template \"Go to GitHub repo\")\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template)\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template)\n\n\n\n_Call-to-Action buttons_\n\n\n\n[](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate)\n\n[](https://marketingpip.github.io/Awesome-Repo-Template/)\n\n\n_Documentation button_\n\n\n[](/README.MD \"Go to project documentation\")\n\n\n_Custom button_\n\n\t\n\n\n
\t
\t
\t
\t
\t
\t
\t
\t
\t\n
\t \n\t \n\nAuto Generated Table Of Contents Demo:
\n
\n\n\n- [Features:](#features)\n- [Example and Usage](#example-and-usage)\n- [Contributing  ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a)\n- [License  ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)\n\n\n\n