{"id":28990667,"url":"https://github.com/compas-dev/compas_nanobind_package_template","last_synced_at":"2025-06-25T00:45:28.137Z","repository":{"id":294227764,"uuid":"986311105","full_name":"compas-dev/compas_nanobind_package_template","owner":"compas-dev","description":"Cookiecutter template for COMPAS C++ extensions.","archived":false,"fork":false,"pushed_at":"2025-06-06T10:27:40.000Z","size":63,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-06T11:23:54.937Z","etag":null,"topics":["cibuildwheel","cmake","cookiecutter","cpp","nanobind","python-package","scikit-build","template"],"latest_commit_sha":null,"homepage":"","language":"C++","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,"zenodo":null}},"created_at":"2025-05-19T12:22:31.000Z","updated_at":"2025-06-06T10:27:42.000Z","dependencies_parsed_at":"2025-05-19T13:53:17.804Z","dependency_job_id":"de237e64-5a17-4a99-b086-6382f1d89e9e","html_url":"https://github.com/compas-dev/compas_nanobind_package_template","commit_stats":null,"previous_names":["petrasvestartas/compas_nanobind_package_template","compas-dev/compas_nanobind_package_template"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/compas-dev/compas_nanobind_package_template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_nanobind_package_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_nanobind_package_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_nanobind_package_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_nanobind_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_nanobind_package_template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fcompas_nanobind_package_template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261782729,"owners_count":23208908,"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":["cibuildwheel","cmake","cookiecutter","cpp","nanobind","python-package","scikit-build","template"],"created_at":"2025-06-25T00:45:21.538Z","updated_at":"2025-06-25T00:45:28.098Z","avatar_url":"https://github.com/compas-dev.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# COMPAS package template for C++/Python binding \n\nCookiecutter template for COMPAS C++ based 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* Example project for [nanobind](https://github.com/wjakob/nanobind)\n* Python wheel building via [cibuildwheel](https://github.com/pypa/cibuildwheel) and [scikit-build-core](https://github.com/scikit-build/scikit-build-core) for [PyPI](https://pypi.org/).\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[Detailed instructions](https://docs.google.com/presentation/d/1HL4o8cadvuZlQDsdYlslzeDhDVvTUlPdk9zTSn5fsLA/edit?slide=id.g9da5d6f0fe_0_0#slide=id.g9da5d6f0fe_0_0)\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 95-99.\nBy default the package is uploaded to test.pypi.org. For publishing to pypi.org delete lines 97-99.\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_nanobind_package_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompas-dev%2Fcompas_nanobind_package_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompas-dev%2Fcompas_nanobind_package_template/lists"}