{"id":20101569,"url":"https://github.com/xtensor-stack/xtensor-python-cookiecutter","last_synced_at":"2025-05-06T06:33:28.669Z","repository":{"id":75958901,"uuid":"73435183","full_name":"xtensor-stack/xtensor-python-cookiecutter","owner":"xtensor-stack","description":"Cookiecutter for a Python project making use of xtensor","archived":false,"fork":false,"pushed_at":"2019-12-26T17:52:15.000Z","size":194,"stargazers_count":31,"open_issues_count":2,"forks_count":9,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-09T09:51:48.759Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xtensor-stack.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":"2016-11-11T01:23:33.000Z","updated_at":"2023-10-25T08:53:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"78fdf0b9-93c9-440b-8d8e-e7e9fd9ea596","html_url":"https://github.com/xtensor-stack/xtensor-python-cookiecutter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtensor-stack%2Fxtensor-python-cookiecutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtensor-stack%2Fxtensor-python-cookiecutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtensor-stack%2Fxtensor-python-cookiecutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtensor-stack%2Fxtensor-python-cookiecutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xtensor-stack","download_url":"https://codeload.github.com/xtensor-stack/xtensor-python-cookiecutter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252633904,"owners_count":21779944,"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":"2024-11-13T17:25:47.425Z","updated_at":"2025-05-06T06:33:28.662Z","avatar_url":"https://github.com/xtensor-stack.png","language":"Python","readme":"# ![xtensor-cookiecutter](xtensor-cookiecutter.svg)\n\n[![Travis](https://travis-ci.org/xtensor-stack/xtensor-python-cookiecutter.svg?branch=master)](https://travis-ci.org/xtensor-stack/xtensor-python-cookiecutter)\n[![Appveyor](https://ci.appveyor.com/api/projects/status/jpplisnhk808l8c8?svg=true)](https://ci.appveyor.com/project/xtensor-stack/xtensor-python-cookiecutter)\n[![Documentation Status](https://readthedocs.org/projects/xtensor/badge/?version=latest)](https://xtensor.readthedocs.io/en/latest/?badge=latest)\n[![Join the Gitter Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/QuantStack/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n#### A [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating a custom Python extension with xtensor\n\n## What is xtensor-python-cookiecutter?\n\n`xtensor-python-cookiecutter` helps extension authors create Python extension modules making use of xtensor.\n\nIt takes care of the initial work of generating a project skeleton with\n\n- A complete `setup.py` compiling the extension module\n- A few examples included in the resulting project including\n\n    - A universal function defined from C++\n    - A function making use of an algorithm from the STL on a numpy array\n    - Unit tests\n    - The generation of the HTML documentation with sphinx\n\n## Usage\n\nInstall [cookiecutter](https://github.com/audreyr/cookiecutter):\n\n    $ pip install cookiecutter\n\nAfter installing cookiecutter, use the xtensor-python-cookiecutter:\n\n    $ cookiecutter https://github.com/xtensor-stack/xtensor-python-cookiecutter.git\n\nAs xtensor-python-cookiecutter runs, you will be asked for basic information about\nyour custom extension project. You will be prompted for the following\ninformation:\n\n- `author_name`: your name or the name of your organization,\n- `author_email`: your project's contact email,\n- `github_project_name`: name of the GitHub repository for your project,\n- `github_organization_name`: name of the GithHub organization for your project,\n- `python_package_name`: name of the Python package created by your extension,\n- `cpp_namespace`: name for the cpp namespace holding the implementation of your extension,\n- `project_short_description`: a short description for your project.\n  \nThis will produce a directory containing all the required content for a minimal extension\nproject making use of xtensor with all the required boilerplate for package management,\ntogether with a few basic examples. The generated Python extension requires an installation\nof  `xtensor` `^0.18.0`, `xtensor-python` `^0.21.0`, `numpy`, and `pybind11` `^2.1.0`.\n\nInstall the module:\n\n    $ pip install ./{{ cookiecutter.github_project_name }}/\n\n\nIf you have [Jupyter](jupyter.org) installed, run the [Test_Run notebook](http://nbviewer.jupyter.org/github/xtensor-stack/xtensor-python-cookiecutter/blob/master/Test_Run.ipynb):\n\n    $ cd {{ cookiecutter.github_project_name }}\n    $ jupyter notebook\n\n## Resources\n\n- [Documentation of xtensor](https://xtensor.readthedocs.io/en/latest/)\n- [Documentation of xtensor-python](https://xtensor-pyhton.readthedocs.io/en/latest/)\n- [Documentation of xtensor-julia](https://xtensor-julia.readthedocs.io/en/latest/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxtensor-stack%2Fxtensor-python-cookiecutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxtensor-stack%2Fxtensor-python-cookiecutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxtensor-stack%2Fxtensor-python-cookiecutter/lists"}