mirror of
https://github.com/MunGell/awesome-for-beginners.git
synced 2026-01-25 12:58:17 -08:00
Compare commits
10 Commits
9e6dacc927
...
9791a45ebd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9791a45ebd | ||
|
|
b9fd746973 | ||
|
|
aeba4b6c1f | ||
|
|
108c7b10a4 | ||
|
|
35c7ae728b | ||
|
|
5f83071e6e | ||
|
|
b5e6e14219 | ||
|
|
dc8eaa529d | ||
|
|
e0d5ac11c6 | ||
|
|
663f4c351e |
76
.github/scripts/render-readme.py
vendored
76
.github/scripts/render-readme.py
vendored
@@ -1,5 +1,10 @@
|
||||
from jinja2 import Environment, FileSystemLoader
|
||||
import json
|
||||
import os
|
||||
import logging
|
||||
|
||||
# Configuring logging
|
||||
logging.basicConfig(level=logging.INFO)
|
||||
|
||||
DATAFILE = "./data.json"
|
||||
TEMPLATEPATH = "./.github/"
|
||||
@@ -9,34 +14,61 @@ TARGETFILE = "./README.md"
|
||||
def new_technology_dict(repo_technology):
|
||||
return {"link_id": repo_technology.lower(), "entries": []}
|
||||
|
||||
# Function to log warnings for missing data
|
||||
def log_warning(message):
|
||||
logging.warning(message)
|
||||
|
||||
# Check if the data file exists
|
||||
if not os.path.exists(DATAFILE):
|
||||
log_warning(f"Data file {DATAFILE} does not exist.")
|
||||
exit(1)
|
||||
|
||||
# Load data from the JSON file
|
||||
try:
|
||||
with open(DATAFILE, "r") as datafile:
|
||||
data = json.loads(datafile.read())
|
||||
except json.JSONDecodeError:
|
||||
log_warning("Error: Failed to parse JSON data in the file.")
|
||||
exit(1)
|
||||
|
||||
# Initialize technologies dictionary
|
||||
technologies = {}
|
||||
|
||||
with open(DATAFILE, "r") as datafile:
|
||||
data = json.loads(datafile.read())
|
||||
|
||||
for technology in data["technologies"]:
|
||||
# Processing technologies
|
||||
for technology in data.get("technologies", {}):
|
||||
technologies[technology] = {
|
||||
"link_id": data["technologies"][technology],
|
||||
"link_id": data["technologies"].get(technology),
|
||||
"entries": [],
|
||||
}
|
||||
|
||||
for repository in data["repositories"]:
|
||||
repo_technologies = repository["technologies"]
|
||||
# Processing repositories
|
||||
for repository in data.get("repositories", []):
|
||||
repo_technologies = repository.get("technologies", [])
|
||||
if not repo_technologies:
|
||||
log_warning(f"Repository {repository['name']} has no technologies listed.")
|
||||
for repo_technology in repo_technologies:
|
||||
if not technologies.get(repo_technology, False):
|
||||
if repo_technology not in technologies:
|
||||
technologies[repo_technology] = new_technology_dict(repo_technology)
|
||||
log_warning(f"Technology {repo_technology} is newly added.")
|
||||
technologies[repo_technology]["entries"].append(repository)
|
||||
|
||||
# Create Jinja2 environment and load the template
|
||||
env = Environment(loader=FileSystemLoader(TEMPLATEPATH))
|
||||
if not os.path.exists(os.path.join(TEMPLATEPATH, TEMPLATEFILE)):
|
||||
log_warning(f"Template file {TEMPLATEFILE} does not exist in the provided path.")
|
||||
exit(1)
|
||||
template = env.get_template(TEMPLATEFILE)
|
||||
|
||||
# Create categories from the technologies
|
||||
categories = []
|
||||
for key, value in zip(technologies.keys(), technologies.values()):
|
||||
for key, value in technologies.items():
|
||||
categories.append(
|
||||
{"title": key, "link_id": value["link_id"], "entries": value["entries"]}
|
||||
)
|
||||
|
||||
# Sorting categories and entries
|
||||
categories = sorted(categories, key=lambda x: x["title"].upper())
|
||||
|
||||
category_groups = {"Misc": []}
|
||||
for category in categories:
|
||||
category["entries"] = sorted(category["entries"], key=lambda x: x["name"].upper())
|
||||
@@ -48,8 +80,28 @@ for category in categories:
|
||||
else:
|
||||
category_groups["Misc"].append(category)
|
||||
|
||||
sponsors = data["sponsors"]
|
||||
# Process sponsors
|
||||
sponsors = data.get("sponsors", [])
|
||||
|
||||
output = template.render(category_groups=category_groups, categories=categories, sponsors=sponsors)
|
||||
# Generate Table of Contents (TOC)
|
||||
toc = []
|
||||
for category in categories:
|
||||
toc.append(f"- [{category['title']}]({category['link_id']})")
|
||||
|
||||
open(TARGETFILE, "w").write(output)
|
||||
# Prepare context for rendering the template
|
||||
context = {
|
||||
"category_groups": category_groups,
|
||||
"categories": categories,
|
||||
"sponsors": sponsors,
|
||||
"toc": toc # Adding TOC to context
|
||||
}
|
||||
|
||||
# Rendering the README file
|
||||
try:
|
||||
output = template.render(context)
|
||||
with open(TARGETFILE, "w") as targetfile:
|
||||
targetfile.write(output)
|
||||
logging.info("README file generated successfully.")
|
||||
except Exception as e:
|
||||
log_warning(f"Error while rendering template: {e}")
|
||||
exit(1)
|
||||
|
||||
@@ -194,7 +194,6 @@ If you would like to be guided through how to contribute to a repository on GitH
|
||||
- [Reddit Enhancement Suite](https://github.com/honestbleeps/Reddit-Enhancement-Suite) _(label: help-wanted)_ <br> A browser extension to enhance the Reddit browsing experience.
|
||||
- [Semantic-UI-React](https://github.com/Semantic-Org/Semantic-UI-React) _(label: good first issue)_ <br> The official React integration for Semantic UI.
|
||||
- [serverless](https://github.com/serverless/serverless) _(label: good first issue)_ <br> The Serverless Framework
|
||||
- [SirixDB](https://github.com/sirixdb/sirix-svelte-front-end) _(label: good first issue)_ <br> A Svelte/Sapper based web front-end for SirixDB, which is a versioned NoSQL document store (XML and JSON) written in Java.
|
||||
- [Storybook JS](https://github.com/storybookjs/storybook) _(label: good first issue)_ <br> Storybook is a frontend workshop for building UI components and pages in isolation.
|
||||
- [stryker](https://github.com/stryker-mutator/stryker) _(label: 👶 Good first issue)_ <br> The JavaScript mutation testing framework
|
||||
- [Superalgos](https://github.com/Superalgos/Superalgos) _(label: good first issue)_ <br> A completely Open Source crypto trading bot rewarding good contributions with the SA(Superalgos)-Token.
|
||||
@@ -363,6 +362,7 @@ If you would like to be guided through how to contribute to a repository on GitH
|
||||
- [Amplication](https://github.com/amplication/amplication) _(label: good first issue)_ <br> Amplication is an open-source development tool. It helps you develop quality Node.js applications without spending time on repetitive coding tasks.
|
||||
- [Berry - Active development trunk for Yarn](https://github.com/yarnpkg/berry) _(label: good first issue)_ <br> Fast, reliable, and secure dependency management.
|
||||
- [Booster](https://github.com/boostercloud/booster) _(label: good first issue)_ <br> A truly serverless framework, write your code and deploy it in seconds without any server configuration files.
|
||||
- [Devopness](https://github.com/devopness/devopness) _(label: good first issue)_ <br> Devopness aims to drastically simplify the way we manage cloud applications and multi cloud infrastructure in a secure and productive way.
|
||||
- [Graphback](https://github.com/aerogear/graphback) _(label: good first issue)_ <br> A CLI and runtime framework to generate a GraphQL API in seconds.
|
||||
- [H2O Wave](https://github.com/h2oai/wave) _(label: good first issue)_ <br> Realtime Web Apps and Dashboards framework for Python and R. Suited (not only) for AI audience.
|
||||
- [Hasura GraphQL Engine](https://github.com/hasura/graphql-engine) _(label: good first issue)_ <br> Blazing fast, instant realtime GraphQL APIs on Postgres with fine grained access control, also trigger webhooks on database events.
|
||||
|
||||
18
data.json
18
data.json
@@ -913,15 +913,6 @@
|
||||
],
|
||||
"description": "Ramda Adjunct is the most popular and most comprehensive set of functional utilities for use with Ramda, providing a variety of useful, well tested functions with excellent documentation."
|
||||
},
|
||||
{
|
||||
"name": "SirixDB",
|
||||
"link": "https://github.com/sirixdb/sirix-svelte-front-end",
|
||||
"label": "good first issue",
|
||||
"technologies": [
|
||||
"JavaScript"
|
||||
],
|
||||
"description": "A Svelte/Sapper based web front-end for SirixDB, which is a versioned NoSQL document store (XML and JSON) written in Java."
|
||||
},
|
||||
{
|
||||
"name": "json-editor",
|
||||
"link": "https://github.com/json-editor/json-editor",
|
||||
@@ -1084,6 +1075,15 @@
|
||||
],
|
||||
"description": "Component framework that runs at build time, converting your components into highly efficient imperative code that surgically updates the DOM."
|
||||
},
|
||||
{
|
||||
"name": "Devopness",
|
||||
"link": "https://github.com/devopness/devopness",
|
||||
"label": "good first issue",
|
||||
"technologies": [
|
||||
"TypeScript"
|
||||
],
|
||||
"description": "Devopness aims to drastically simplify the way we manage cloud applications and multi cloud infrastructure in a secure and productive way."
|
||||
},
|
||||
{
|
||||
"name": "Julia Language: Help wanted",
|
||||
"link": "https://github.com/JuliaLang/julia",
|
||||
|
||||
Reference in New Issue
Block a user