{"id":20885823,"url":"https://github.com/compas-dev/compas_package_template","last_synced_at":"2025-05-12T19:31:26.482Z","repository":{"id":45561843,"uuid":"295243244","full_name":"compas-dev/compas_package_template","owner":"compas-dev","description":"Cookiecutter template for COMPAS extensions.","archived":false,"fork":false,"pushed_at":"2024-10-16T09:23:08.000Z","size":169,"stargazers_count":6,"open_issues_count":6,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-01T10:12:47.511Z","etag":null,"topics":["cookiecutter","python-package","template"],"latest_commit_sha":null,"homepage":"","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/compas-dev.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}},"created_at":"2020-09-13T21:46:12.000Z","updated_at":"2024-10-16T09:23:12.000Z","dependencies_parsed_at":"2024-01-25T09:30:51.194Z","dependency_job_id":"24ffb51a-614b-481a-b257-00ac2df4233b","html_url":"https://github.com/compas-dev/compas_package_template","commit_stats":null,"previous_names":["compas-dev/compas_package_template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_package_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_package_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_package_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_package_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compas-dev","download_url":"https://codeload.github.com/compas-dev/compas_package_template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253808198,"owners_count":21967505,"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":["cookiecutter","python-package","template"],"created_at":"2024-11-18T08:14:45.043Z","updated_at":"2025-05-12T19:31:26.080Z","avatar_url":"https://github.com/compas-dev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# COMPAS package template\n\nCookiecutter template for COMPAS extensions.\n\n[Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/readme.html#)\nis a command-line utility that lets you quickly bootstrap a new project from a template.\nIt takes a directory tree and copies it into your new project,\nreplacing all the generic info that finds surrounded by templating tags `{{` and `}}` with your project info written in `cookiecutter.json`.\n\n## Features\n\n* Project directory and file structure\n* Documentation based on [Sphinx](http://www.sphinx-doc.org/en/master/)/[reStructuredText](http://docutils.sourceforge.net/rst.html)\n* Testing framework: [pytest](https://docs.pytest.org/en/latest/)\n* Basic setup script to create pip installable packages\n* Automation of common tasks for development workflow based on [pyinvoke](http://www.pyinvoke.org/) (generate documentation, run tests, check format, etc.)\n* [EditorConfig](https://editorconfig.org/) integration\n* Minimal Github workflows for CI/CD\n\n## What's included\n\n* `.github`\n* `data`\n* `docs`\n* `scripts`\n* `src`\n* `temp`\n* `tests`\n* `.editorconfig`\n* `.gitignore`\n* `CHANGELOG.md`\n* `CONTRIBUTING.md`\n* `LICENSE`\n* `pyproject.toml`\n* `README.md`\n* `requirements-dev.txt`\n* `requirements.txt`\n* `tasks.py`\n\n## Requirements\n\nInstall the `cookiecutter` command line utility: `pip install cookiecutter`.\n\n## Usage\n\nIn the terminal, go to the folder where you want to place your project:\n\n```bash\ncd \u003cyour-projects-folder\u003e\n```\n\nGenerate a new Cookiecutter template layout:\n\n```bash\ncookiecutter gh:compas-dev/compas_package_template\n```\n\nGo to project folder:\n\n```bash\ncd \u003cproject-slug\u003e\n```\n\nAdd the project files to the new `git` repo:\n\n```bash\ngit add .\ngit commit -m \"Initial commit\"\n```\n\n## Additional settings\n\nTo use the coding style feature with [EditorConfig](https://editorconfig.org/):\n\nSome text editors have a native EditorConfig.\nIf yours doesn't, you can download the appropriate plugin [here](https://editorconfig.org/#download).\n\n## Github Actions\n\nBasic CI/CD has already been setup in the .github folder, including automatic building and testing across systems, documentation generation etc.\n\n### Automatic Publishing to PYPI\n\nThis requires adding your PYPI token in the repo or organization secrets as `PYPI`.\nIf you don't need this feature, go to [.github/workflows/release.yaml]({{cookiecutter.project_folder}}/.github/workflows/release.yml) and delete Lines 27~37.\n\n## License\n\nThis template is licensed under the terms of the [MIT License](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompas-dev%2Fcompas_package_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompas-dev%2Fcompas_package_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompas-dev%2Fcompas_package_template/lists"}