Add pipeline for pull requests (#67)

* Add pipeline for pull requests

* Add pipeline for pull requests

* Add pipeline for pull requests

* Add assertion

* Fix type

.github/actions/awesome/action.yaml

@@ -22,7 +22,7 @@ runs:
   using: composite
   steps:
     - name: Install requirements
-      run: python -m pip install -r  ${{ github.action_path }}/requirements.txt
+      run: python -m pip install -r requirements.txt
       shell: bash
 
     - name: Load environment
@@ -37,6 +37,7 @@ runs:
       shell: bash
 
     - name: Commit README
+      if: github.ref == 'refs/heads/main'
       run: |
         git config --global user.name 'Github Actions'
         git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'

.github/actions/awesome/main.py

@@ -1,36 +1,36 @@
+from __future__ import annotations
+
 from itertools import groupby
-import os
-from typing import List, Optional
+from typing import Any, List, Optional
 
 import requests
 import yaml
 from github import Github
 from jinja2.environment import Template
-from pydantic import BaseModel, BaseSettings, HttpUrl
+from pydantic import BaseModel, HttpUrl
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
 class Settings(BaseSettings):
+    model_config = SettingsConfigDict(case_sensitive=False, env_file=".env")
+
     template_path: str
     output_path: str
     data_path: str
 
     github_token: str
     gitlab_token: str
 
-    class Config:
-        case_sensitive = False
-        env_file = ".env"
-
 
-settings = Settings()
+settings = Settings()  # type: ignore
 g = Github(settings.github_token)
 
 
 class Repository(BaseModel):
-    name: Optional[str]
+    name: str | None = None
     repo: HttpUrl
-    description: Optional[str]
-    stars: Optional[int]
+    description: str | None = None
+    stars: int | None = None
     category: str
 
 
@@ -44,7 +44,7 @@ def read_awesome() -> RepositoriesData:
     return repos
 
 
-def render_readme(data: dict) -> str:
+def render_readme(data: dict[str, Any]) -> str:
     with open(settings.template_path, "r") as readme_template:
         template = Template(readme_template.read())
     return template.render({"data": data})
@@ -68,6 +68,7 @@ def load_repo_data(data: RepositoriesData):
             name = repository.repo.path.strip("/").replace("/", "%2F")
             url = f"https://gitlab.com/api/v4/projects/{name}"
             res = requests.get(url, params={"access_token": settings.gitlab_token})
+            assert "star_count" in res.json(), "Invalid GitLab repository"
             star_count = res.json()["star_count"]
             repository.stars = star_count
             if not repository.name:
@@ -80,7 +81,7 @@ def load_repo_data(data: RepositoriesData):
 def run():
     awesome = read_awesome()
     load_repo_data(awesome)
-    repos = awesome.dict()["repositories"]
+    repos = awesome.model_dump()["repositories"]
     repos.sort(key=lambda x: x["category"])
     data = {
         category: sorted(repo, key=lambda x: -x["stars"])

.github/workflows/render.yaml

@@ -7,6 +7,12 @@ on:
     paths:
       - ".github/actions"
       - "awesome.yaml"
+  pull_request:
+    branches:
+      - "main"
+    paths:
+      - ".github/actions"
+      - "awesome.yaml"
   workflow_dispatch:
   schedule:
     - cron: "0 0 * * FRI"

.gitignore

@@ -0,0 +1,2 @@
+.venv
+.env

awesome.yaml

@@ -6,7 +6,7 @@ repositories:
 
   - name: Esmerald
     repo: https://github.com/dymmond/esmerald
-    description: Full suite python web framework with results and design in mind based on Python type hints and pydantic. 
+    description: Full suite python web framework with results and design in mind based on Python type hints and pydantic.
     category: Web
 
   - name: Django Ninja
@@ -125,7 +125,7 @@ repositories:
     category: Utilities
 
   - name: Quart-Schema
-    repo: https://gitlab.com/pgjones/quart-schema
+    repo: https://github.com/pgjones/quart-schema
     description: Quart-Schema is a Quart extension that provides schema validation and auto-generated API documentation.
     category: Web
 
@@ -183,12 +183,12 @@ repositories:
     repo: https://github.com/surenkov/django-pydantic-field
     description: Django JSONField with Pydantic models as a Schema. DRF supported.
     category: Object Mapping
-    
+
   - name: pydantic-sqs
     repo: https://github.com/andrewthetechie/pydantic-sqs
     description: Send and receive pydantic models via AWS SQS
     category: Object Mapping
- 
+
   - name: pydantic-enhanced-serializer
     repo: https://github.com/adamsussman/pydantic-enhanced-serializer
     description: Better pydantic object output for apis including selectable fields and smart object expansions.
@@ -224,10 +224,9 @@ repositories:
     description: FastStream simplifies the process of writing producers and consumers for message queues, handling all the parsing, networking and documentation generation automatically.
     category: Web
 
-
   - name: DocArray
     repo: https://github.com/docarray/docarray
-    description: Represent, send, store and search multimodal data based on Pydantic. Compatible with Multiple Vector Databases 
+    description: Represent, send, store and search multimodal data based on Pydantic. Compatible with Multiple Vector Databases
     category: Machine Learning
 
   - name: BlackSheep
@@ -237,22 +236,19 @@ repositories:
 
   - repo: https://github.com/jxnl/instructor
     category: Machine Learning
-    # optional
     name: Instructor
     description: Controlling OpenAI Function Calling via Pydantic Models
-  
+
   - repo: https://github.com/opencubes-ai/laktory
     category: Data Engineering
-    # optional
     name: Laktory
     description: A DataOps framework for building Databricks lakehouse.
 
   - repo: https://github.com/okube-ai/settus
     category: Utilities
-    # optional
     name: Settus
     description: Settings management using Pydantic Settings and extended to secrets from Azure Keyvault, Databricks secrets, AWS Secrets Manager and GCP Secrets Manager
-  
+
   - repo: https://github.com/allmonday/pydantic-resolve
     category: Utilities
     name: Pydantic-resolve
@@ -271,7 +267,7 @@ repositories:
   - repo: https://github.com/Viicos/flake8-pydantic
     category: Utilities
     name: Flake8 Pydantic
-    description: A Flake8 plugin to check Pydantic related code. 
+    description: A Flake8 plugin to check Pydantic related code.
 
   - repo: https://github.com/Mirascope/mirascope
     category: Machine Learning
@@ -284,6 +280,6 @@ repositories:
     description: Pydantic-based HTTP forms
 
   - repo: https://github.com//ManiMozaffar/aioclock
-    cateogry: Utilities
+    category: Utilities
     name: AioClock
     description: Scheduler framework asyncio-based designed for execution of periodic task with dependency injection

requirements.txt

@@ -0,0 +1,8 @@
+PyYAML==5.3.1
+pydantic
+pydantic-settings
+Jinja2
+PyGithub==1.55
+
+# Lint
+ruff