{"id":28705056,"url":"https://github.com/esther-poniatowski/keystone","last_synced_at":"2025-10-15T07:55:40.656Z","repository":{"id":266791305,"uuid":"899170684","full_name":"esther-poniatowski/keystone","owner":"esther-poniatowski","description":"Project template providing structured initialization for tool integration and configuration","archived":false,"fork":false,"pushed_at":"2025-06-01T14:19:11.000Z","size":3318,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-01T23:29:45.733Z","etag":null,"topics":["configuration","development","template-project","tool-integration"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/esther-poniatowski.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2024-12-05T18:47:14.000Z","updated_at":"2025-06-01T14:19:14.000Z","dependencies_parsed_at":"2024-12-06T06:28:41.896Z","dependency_job_id":"c83b0c55-386f-432c-9dcf-21e264dea9c5","html_url":"https://github.com/esther-poniatowski/keystone","commit_stats":null,"previous_names":["esther-poniatowski/projecttemplate","esther-poniatowski/keystone"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/esther-poniatowski/keystone","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esther-poniatowski%2Fkeystone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esther-poniatowski%2Fkeystone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esther-poniatowski%2Fkeystone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esther-poniatowski%2Fkeystone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/esther-poniatowski","download_url":"https://codeload.github.com/esther-poniatowski/keystone/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esther-poniatowski%2Fkeystone/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259827666,"owners_count":22917714,"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":["configuration","development","template-project","tool-integration"],"created_at":"2025-06-14T14:09:38.836Z","updated_at":"2025-10-15T07:55:35.611Z","avatar_url":"https://github.com/esther-poniatowski.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nTODO: Replace all placeholders of the form `{{ ... }}` with project-specific values.\n\n- `{{ repo_name }}`          : Repository name\n- `{{ github_user }}`        : GitHub username of the project owner\n- `{{ package_name }}`       : Python package name\n- `{{ channel_name }}`       : Conda channel name\n- `{{ contact@example.com }}`: Contact email address\n- `{{ description }}`        : Short project description, as it appears on the repository page\n\nTODO: Review and adapt all descriptive content to reflect the specific details of the project (e.g.,\nbadges, feature list, variable names, file paths, command-line examples, documentation links).\n--\u003e\n# {{ repo_name }}\n\n[[![Conda](https://img.shields.io/badge/conda-{{ channel_name }}--channel-blue)](#installation)\n[![Maintenance](https://img.shields.io/maintenance/yes/2025)]()\n[![Last Commit](https://img.shields.io/github/last-commit/{{ github_user }}/{{ package_name }})](https://github.com/{{ github_user }}/{{ package_name }}/commits/main)\n[![Python](https://img.shields.io/badge/python-supported-blue)](https://www.python.org/)\n[![License: GPL](https://img.shields.io/badge/License-GPL-yellow.svg)](https://opensource.org/licenses/GPL-3.0)\n\n{{ description }}\n\n---\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Documentation](#documentation)\n- [Support](#support)\n- [Contributing](#contributing)\n- [Acknowledgments](#acknowledgments)\n- [License](#license)\n\n## Overview\n\n---\n\n## Features\n\n- [X] **Feature 1:** Description.\n- [ ] **Feature 2:** Description.\n\n---\n\n## Installation\n\nTo install the package and its dependencies, use one of the following methods:\n\n### Using Pip Installs Packages\n\nInstall the package from the GitHub repository URL via `pip`:\n\n```bash\npip install git+https://github.com/{{ github_user }}/{{ repo_name }}.git\n```\n\n### Using Conda\n\nInstall the package from the private channel {{ channel_name }}:\n\n```bash\nconda install {{ package_name }} -c {{ channel_name }}\n```\n\n### From Source\n\n1. Clone the repository:\n\n      ```bash\n      git clone https://github.com/{{ github_user }}/{{ repo_name }}.git\n      ```\n\n2. Create a dedicated virtual environment:\n\n      ```bash\n      cd {{ repo_name }}\n      conda env create -f environment.yml\n      ```\n\n---\n\n## Usage\n\n### Command Line Interface (CLI)\n\nTo display the list of available commands and options:\n\n```sh\n{{ package_name }} --help\n```\n\n### Programmatic Usage\n\nTo use the package programmatically in Python:\n\n```python\nimport {{ package_name }}\n```\n\n---\n\n## Configuration\n\n### Environment Variables\n\n|Variable|Description|Default|Required|\n|---|---|---|---|\n|`VAR_1`|Description 1|None|Yes|\n|`VAR_2`|Description 2|`false`|No|\n\n### Configuration File\n\nConfiguration options are specified in YAML files located in the `config/` directory.\n\nThe canonical configuration schema is provided in [`config/default.yaml`](config/default.yaml).\n\n```yaml\nvar_1: value1\nvar_2: value2\n```\n\n---\n\n## Documentation\n\n- [User Guide](https://{{ github_user }}.github.io/{{ repo_name }}/guide/)\n- [API Documentation](https://{{ github_user }}.github.io/{{ repo_name }}/api/)\n\n\u003e [!NOTE]\n\u003e Documentation can also be browsed locally from the [`docs/`](docs/) directory.\n\n## Support\n\n**Issues**: [GitHub Issues](https://github.com/{{ github_user }}/{{ repo_name }}/issues)\n\n**Email**: `{{ contact@example.com }}`\n\n---\n\n## Contributing\n\nPlease refer to the [contribution guidelines](CONTRIBUTING.md).\n\n---\n\n## Acknowledgments\n\n### Authors \u0026 Contributors\n\n**Author**: @{{ github_user }}\n\n**Contact**: `{{ contact@example.com }}`\n\nFor academic use, please cite using the GitHub \"Cite this repository\" feature to\ngenerate a citation in various formats.\n\nAlternatively, refer to the [citation metadata](CITATION.cff).\n\n### Third-Party Dependencies\n\n- **[Library A](link)** - Purpose\n- **[Library B](link)** - Purpose\n\n---\n\n## License\n\nThis project is licensed under the terms of the [GNU General Public License v3.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Festher-poniatowski%2Fkeystone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Festher-poniatowski%2Fkeystone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Festher-poniatowski%2Fkeystone/lists"}