{"id":29430278,"url":"https://github.com/precice/config-format","last_synced_at":"2025-07-12T17:06:25.303Z","repository":{"id":299641281,"uuid":"1003704513","full_name":"precice/config-format","owner":"precice","description":"A small python tool for consistently formatting preCICE configurations","archived":false,"fork":false,"pushed_at":"2025-06-24T10:37:30.000Z","size":22,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-02T20:53:57.799Z","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/precice.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},"funding":{"custom":"https://precice.org/community-support-precice"}},"created_at":"2025-06-17T14:40:47.000Z","updated_at":"2025-06-24T10:37:33.000Z","dependencies_parsed_at":"2025-06-17T15:36:47.877Z","dependency_job_id":"2a6d6375-3786-4f74-a431-67018d967f54","html_url":"https://github.com/precice/config-format","commit_stats":null,"previous_names":["precice/config-format"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/precice/config-format","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-format","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-format/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-format/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-format/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/precice","download_url":"https://codeload.github.com/precice/config-format/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-format/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265024860,"owners_count":23699621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2025-07-12T17:06:24.736Z","updated_at":"2025-07-12T17:06:25.295Z","avatar_url":"https://github.com/precice.png","language":"Python","funding_links":["https://precice.org/community-support-precice"],"categories":[],"sub_categories":[],"readme":"# preCICE Config-Format\n\n`config-format` is a tool meant to format preCICE configurations consistently. A uniform order simplifies cooperation debugging.\n\n## Installation options\n\nInstall directly from PyPi using [pipx](https://pipx.pypa.io/stable/) or via pip:\n\n```console\npipx install precice-config-format\n```\n\n## Usage\n\nTo format one or more preCICE configuration files in-place:\n\n```console\nprecice-config-format FILE ...\n```\n\nThe script returns with exit code 0 on success, 1 on error, and 2 if a file was modified.\n\n## pre-commit hook\n\nTo use this script as a pre-commit hook select [a tag](https://github.com/precice/config-format/tags) and add:\n\n```yaml\n-   repo: https://github.com/precice/config-format\n    rev: ''  # Use the tag you want to use\n    hooks:\n    -   id: precice-config-format\n```\n\nTo exclude directories, use `exclude:`\n\n```yaml\n-   repo: https://github.com/precice/config-format\n    rev: ''  # Use the tag you want to use\n    hooks:\n    -   id: precice-config-format\n        exclude: '^thridparty' # optionally exclude directories here\n```\n\n## Licensing\n\nThis repository contains a modified version of `format_precice_config.py`, which was part of the repository [precice/precice-pre-commit-hooks](https://github.com/precice/precice-pre-commit-hooks/blob/v3.3/format_precice_config/format_precice_config.py).\nThe copyright holder Frédéric Simonis (@fsimonis frederic.simonis@ipvs.uni-stuttgart.de) decided on 23. June 2025 16:30 CET to rerelease the content of the file `format_precice_config.py` in this repository under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecice%2Fconfig-format","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprecice%2Fconfig-format","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecice%2Fconfig-format/lists"}