{"id":23069549,"url":"https://github.com/roboticsbrno/projectindexer","last_synced_at":"2026-03-01T18:31:28.874Z","repository":{"id":168050371,"uuid":"596653329","full_name":"RoboticsBrno/ProjectIndexer","owner":"RoboticsBrno","description":"🔗 ProjectIndexer is a static web generator written in Python.","archived":false,"fork":false,"pushed_at":"2025-11-01T01:01:21.000Z","size":2045,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-11-01T03:04:44.239Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://robotikabrno.cz/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RoboticsBrno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-02-02T16:46:53.000Z","updated_at":"2025-10-15T20:14:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"9dcc08ad-9c28-4bcf-af25-1eff02b93d5d","html_url":"https://github.com/RoboticsBrno/ProjectIndexer","commit_stats":null,"previous_names":["roboticsbrno/projectindexer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RoboticsBrno/ProjectIndexer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboticsBrno%2FProjectIndexer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboticsBrno%2FProjectIndexer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboticsBrno%2FProjectIndexer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboticsBrno%2FProjectIndexer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RoboticsBrno","download_url":"https://codeload.github.com/RoboticsBrno/ProjectIndexer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboticsBrno%2FProjectIndexer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29978477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T16:35:47.903Z","status":"ssl_error","status_checked_at":"2026-03-01T16:35:44.899Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T06:15:56.350Z","updated_at":"2026-03-01T18:31:28.855Z","avatar_url":"https://github.com/RoboticsBrno.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ProjectIndexer\nThis is a RoboticsBrno indexer generator for out GitHub projects.\nProjectIndexer is a static web generator written in Python.\nIt generates a static web page with a list of all our projects based on the GitHub API.\n\n## How to use it\n1. Clone this repository\n2. Install dependencies\n3. create file `.env` with content `MY_GITHUB_TOKEN=your_github_token`\n    - you can generate your token [here](https://github.com/settings/tokens?type=beta)\n4. run `python3 project_indexer.py --help` to see available options\n\n## ProjectIndexer options\n- `fetch-github` - fetches data from GitHub API and saves it to `data/repos.json`\n- `generate` - generates static web page from `data/repos.json` and saves it to `output` folder\n  - `--compile-tailwind` - compiles tailwind css\n- `serve` - serves the static web page from `output` folder\n\nMore predefined commands in `Makefile`.\n\n# Indexace projektů pro RoboticsBrno (CZ)\n\nTento projekt slouží k automatickému generování portfolia projektů naší organizace na GitHubu.\nProjektIndexer je statický web generátor napsaný v Pythonu a měl by se automaticky spouštět v nastavených intervalech pomocí GitHub Actions.\n\n## Cíl\nCílem projektu je udržovat aktuální seznam, popis a informace o projektech bez nutnosti ruční údržby.\nUkázat veřejnosti (i členům) naši práci v přehledné a jednoduché formě na webu.\nProjekty se budou seskupovat podle kategorií a bude možné je filtrovat například podle projektů.\nKaždý projekt bude mít svoji podstránku s relevantními informacemi a odkazy na repozitáře.\nČást funkcionality se bude zpracovávat z informací (tagů, popisu) z GitHubu a druhou část bude muset uživatel vyplnit ručně (např. obrázky, popis - asi YAML).\n\n## Fungování\n\n## Data z GitHubu\nData o projektech se získávají z GitHub API. Pro získání dat je potřeba mít GitHub token, který se uloží do souboru `.env` do proměnné `MY_GITHUB_TOKEN`.\n\nZpracovávaná data\n- `name` - název projektu\n- `description` - popis projektu\n- `html_url` - odkaz na GitHub repozitář\n- `homepage` - odkaz na web projektu\n- `topics` - tagy projektu\n  - jelikož se dají tagy jednoduše nastavovat, můžeme je použít pro kategorizaci projektů (např. `robotka`, `rbcx`, `smd-challenge`, `hardware`, ...)\n  - také by šlo taky využit na skrývýní / zobrazení projektů na webu (např. `hidden`). Nebo naopak zveřejnění hlavičky privátního repozitáře (např. `private-publish-header`) - pro kompletní prolinkování našich repozitářů.\n- `language` - programovací jazyk projektu\n- `created_at` - datum vytvoření projektu\n  - lze využít pro řazení projektů\n- `updated_at` - datum poslední aktualizace projektu\n  - lze využít pro řazení projektů\n  - na úvodní stránce můžeme informovat o změnách v projektech\n- `license` - licence projektu\n- `contributors` - seznam přispěvatelů\n  - do budoucna propojit s https://team.robotikabrno.cz/ (lépe sjednotit)\n- `readme` - obsah README.md\n  - zobrazit na podstránce projektu (správně zpracovat obrázky, odkazy, ...)\n- `images` - obrázky projektu\n  - aktuálně nejspíš nepoužíváme (možná do budoucna)\n- `stars` - počet hvězdiček\n  - lze využít pro řazení projektů\n- `issues` - počet issues\n\n### README a popis projektu\nKaždý repozitář by měl mít ideálně nastaven Popis projektu na GH a ideálně by měl obsahovat i README.md soubor (CZ/EN - lépe EN).\nPokud nebude README.md soubor, tak se zobrazí pouze popis projektu z GH.\nPopis projektu by mohl ideálně začínat Emoji (např. 🤖 ) a následně krátkým popisem projektu.\n\n### Obrázky projektu\nObrázky projektu by měly být v adresáři `images` případně `img` v kořenovém adresáři repozitáře.\nNa webu se budou řadit podle názvů z repa.\nAkceptované soubory: `.png`, `.jpg`, `.jpeg`, (`.svg` spíše ne).\n\n## Doplnění dat\nNěkterá data se nedají získat z GitHubu a je potřeba je doplnit ručně.\n\n### Kategorie\nAby bylo možné projekty seskupovat do kategorií, je potřeba každý projekt označit tagem v GitHubu.\nPři generování se bude hledat složka `projects` a v ní soubor s názvem tagu (např. `robotka.md`).\nReadme bude začínat YAML hlavičkou s informacemi o projektu.\n```yaml\nname: Robotka\nname_cz: Robotka\ndescription: Robotka is a small robot for educational purposes.\ndescription_cz: Robotka je malý robot pro vzdělávací účely.\nrepository:\n  - name: robotka library\n    url: https://github.com/RoboticsBrno/RB3204-RBCX-Robotka-library\n  - name: robotka-examples\n    url: https://github.com/RoboticsBrno/robotka-examples\nweb: https://robotka.robotickytabor.cz/\nauthors:\n  - name: Jan Novák (dohledá si další údaje samo)\n...\n---\nMarkdown text...\n\n```\n\n### Obrázky\nCesta k obrázkům začíná `R:\u003crepo name\u003e/images/...` (např. `R:robotka/images/...`)\n\n## Úvodní stránka\nKdo jsme a co děláme.\nTahle stánka ideálně anglicky i česky - zbytek stačí v angličtině (pokud je to možné).\n\nDéle zde zobrazova informace o změnách v projektech (např. poslední aktualizace).\nNachystat několik šablon a při každé kompilaci se náhodně vybere jedna a zobrazí se na úvodní stránce (např. obrázek z nějakého projektu s popisem a linkem).\n\n## Náš tým\nZde by se měli zobrazovat členové týmu (případně i přispěvatelé).\nPřesunout informace z https://team.robotikabrno.cz/ sem na jeden web.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froboticsbrno%2Fprojectindexer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froboticsbrno%2Fprojectindexer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froboticsbrno%2Fprojectindexer/lists"}