{"id":42926755,"url":"https://github.com/coderefinery/git-calendar","last_synced_at":"2026-01-30T18:10:40.929Z","repository":{"id":40545665,"uuid":"415275696","full_name":"coderefinery/git-calendar","owner":"coderefinery","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-01T19:24:37.000Z","size":67,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-10T04:44:27.163Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderefinery.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-10-09T10:25:28.000Z","updated_at":"2025-09-01T19:24:19.000Z","dependencies_parsed_at":"2025-09-10T03:18:44.281Z","dependency_job_id":"c1feac97-1b4c-45e1-b8f9-e1d828c23f06","html_url":"https://github.com/coderefinery/git-calendar","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/coderefinery/git-calendar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fgit-calendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fgit-calendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fgit-calendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fgit-calendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderefinery","download_url":"https://codeload.github.com/coderefinery/git-calendar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fgit-calendar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28917035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T16:37:38.804Z","status":"ssl_error","status_checked_at":"2026-01-30T16:37:37.878Z","response_time":66,"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":"2026-01-30T18:10:40.231Z","updated_at":"2026-01-30T18:10:40.924Z","avatar_url":"https://github.com/coderefinery.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAML to ics calendar\n\nThis repository turns yaml files into .ics calendars (importable into\ndifferent programs) using\n[yaml2ics](https://github.com/scientific-python/yaml2ics) and GitHub\nactions.  Or, you can use git-calendar directly.\n\nThis repository provides a working template for the action to build +\npublish to Github Pages, including files into other files, and some\nminimal HTML index pages.  All of the important logic is in\n[yaml2ics](https://github.com/scientific-python/yaml2ics), so if you\nwant to roll your own site and build system (which isn't hard) for the\n.ics files, consider using yaml2ics directly.\n\n\n\n## Example deployments\n\nThe CodeRefinery calendar\n* [Built calendar site](https://coderefinery.github.io/calendar/)\n  (the auto-generated landing page)\n* [Source repository](https://github.com/coderefinery/calendar)\n* Optional: [Calendars inserted into\n  website](https://coderefinery.org/calendars/) ([source](https://github.com/coderefinery/coderefinery.org/blob/main/content/calendars.md))\n\n\n\n## General principles\n\nOne defines events in YAML, and they get built to `.ics` files which\ncan be served as a static site.  These can then be imported to various\ncalendar clients.\n\nThere's a command line program, `git-calendar`, which takes YAML files\nas input (one of which can be named `_config.yaml`).  The last\nargument is the output directory to which to write.\n\nA typical repository layout:\n\n- `calendars/*.yaml` contains the input calendars.\n- `output/` is the web root for web deployment\n- `output/*.ics` is the build calendars\n- `output/index.html` gets built and serves as a landing page with\n  links to the .ics files\n\nFor now, see `calendars/example.yaml` for an example, or any of the\ntest calendars in yaml2ics.  This documentation should be improved.\n\n\n\n## Usage - Github action\n\nThis can be used as Github action (see EXAMPLE REPO for the full file).\n\n```yaml\n      - uses: actions/checkout@v4\n      - name: git-calendar action\n        uses: coderefinery/git-calendar@action-test\n        with:\n          input_dir: calendars    # the default, not required\n          output_dir: output      # the default, not required\n          index_file: index.html  # the default, set to '' to not\n        create\n        htmlbody_file: body.html  # Only the part inside \u003cbody\u003e for inclusion in other files\n```\n\nThis action will automatically deploy to Github Pages.  You can set\n`with: pages_deploy: false` to disable this.  The action will also\nsetup Python and install this Python library.  If you already set up\nPython, it may be easier to code up your own action than use this.\n\n\n\n## Usage - Raw Github action\n\nIf you want to program the action yourself, below is the base.  You\nprobably can probably figure out how to integrate this to a Github\nPages deployment and all.\n```yaml\n    - name: build\n      shell: bash\n      run: |\n        git-calendar calendars/*.yaml output/ --index=index.html --edit-link=https://github.com/$GITHUB_REPOSITORY\n```\n\n\n\n## Usage - command line\n\nThis is a Python package, install as normal (yes, in a virtual environment, etc...):\n```console\n$ pip install git-calendar\n```\n\nThen run:\n\n```console\n$ git-calendar calendars/*.yaml output/ --index=index.html --edit-link=https://github.com/$GITHUB_REPOSITORY\n```\n\nThere are more options, not currently documented.\n\n\n\n## Usage - via raw yaml2ics\n\nDon't forget this is just a wrapper around\n[yaml2ics](https://github.com/scientific-python/yaml2ics) - if you\nonly need a .ics file and not index.html, including calendars in\nothers, etc., then maybe that is your starting point:\n\n```console\n$ python yaml2ics.py example/test_calendar.yaml example/another_calendar.yaml \u003e out.ics\n```\n\n\n\n## Status\n\nBeta as of 2025, it works but may require code changes still to get\naround corner cases.  As of 2025 issues will probably be responded to.\n\n\n\n## See also\n\n* This directly uses https://github.com/scientific-python/yaml2ics as\n  the yaml to ical generator - if you want to create your own build\n  system, use that directly.\n* yaml2ics uses https://github.com/ics-py/ics-py/\n* Another (old, unmaintained, not really usable) yaml-to-ics is\n  https://github.com/priyeshpatel/yaml-to-ical\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fgit-calendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderefinery%2Fgit-calendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fgit-calendar/lists"}