| Name | whiteprints JSON |
| Version |
0.10.2
JSON |
| download |
| home_page | None |
| Summary | A Copier-based cookiecutter for creating Python projects managed by uv. |
| upload_time | 2024-10-21 10:09:05 |
| maintainer | Romain Brault |
| docs_url | None |
| author | Romain Brault |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<!--
SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
SPDX-License-Identifier: CC-BY-NC-SA-4.0
-->
# Whiteprints
<div align="center">
<p>
<em>
A Copier-based cookiecutter for creating Python projects managed by uv.
</em>
</p>
<p>
<a href="https://www.python.org"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/whiteprints.svg?logo=Python&logoColor=ffd43b"/></a>
<a href="https://pypi.org/project/whiteprints"><img alt="PyPI - Project Version" src="https://img.shields.io/pypi/v/whiteprints.svg?logo=PyPI&logoColor=ffd43b"/></a>
<a href="https://spdx.org/licenses/GPL-3.0-or-later"><img alt="license badge" src="https://img.shields.io/badge/📝_License-GPL--3.0--or--later-4CAF50.svg"/></a>
<a href="https://github.com/whiteprints/whiteprints/discussions"><img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/whiteprints/whiteprints.svg?logo=GitHub"></a>
<a href="https://spdx.dev/learn/areas-of-interest/licensing/"><img alt="SPDX Licensing" src="https://img.shields.io/badge/SPDX-licensing-0080FF.svg?logo=SPDX"/></a>
<a href='https://readthedocs.org/projects/whiteprints/'><img src='https://readthedocs.org/projects/whiteprints/badge/?version=latest' alt='Documentation Status' /></a>
<a href="https://www.contributor-covenant.org/version/2/1/code_of_conduct/"><img alt="contributor covenant badge" src="https://img.shields.io/badge/Contributor_Covenant-2.1-4BAAAA.svg?logo=contributorcovenant"/></a>
<a href="https://codecov.io/gh/whiteprints/whiteprints" ><img alt="CodeCov code coverage" src="https://codecov.io/gh/whiteprints/whiteprints/graph/badge.svg?token=YrFGtQ5D5F"/></a>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href="https://github.com/whiteprints/whiteprints?tab=readme-ov-file#contributors" ><img alt="All Contributors" src="https://img.shields.io/github/all-contributors/whiteprints/whiteprints?color=ee8449\"/></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
</p>
</div>
## Table of contents
- [Background](#background)
- [Highlights](#highlights)
- [Install](#install)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [Licensing](#licensing)
## Background
whiteprints is a command line to generate [Python] projects managed by [uv].
This is currently for my personal use, the documentation needs to be vastly
improved. However if you like the project feel free to use it, ask me questions
and even contribute 😊.
## Highlights
- Managed by [uv]
- [Tox], [Pytest] and [Sphinx] for the development
- Template for [GitHub] with actions to publish to [PyPI], [ReadTheDocs] and
[CodeCov]
The whiteprint command line is under [GPL-3.0-or-later] license, however the
code templates used to generate the code are under [MIT-0] license.
### Try it!
All you need is a working `uv`. If you don't already have it just open a
terminal and run:
- On macOS and Linux:
```console
curl -LsSf https://astral.sh/uv/install.sh | sh
```
- On Windows:
```console
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
```
Then just run whiteprints with uvx:
```
uvx whiteprints init my_awesome_project
```
Answer a few questions and you're ready to go 🚀.
This will create a directory named `my_awesome_project` containing your [Python] project.
To generate a [GitHub] template please look at the command line help
```
uvx whiteprints init --help
```
You may also have a look at the [Documentation](https://whiteprints.readthedocs.io/en/stable/)
## Documentation
See: https://whiteprints.readthedocs.io/en/stable/.
## Install
See [INSTALL.md](https://github.com/whiteprints/whiteprints/blob/main/INSTALL.md).
## Maintainers
See [MAINTAINERS.md](https://github.com/whiteprints/whiteprints/blob/main/MAINTAINERS.md).
## Contributing
See [CONTRIBUTING.md](https://github.com/whiteprints/whiteprints/blob/main/CONTRIBUTING.md).
## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/RomainBrault"><img src="https://avatars.githubusercontent.com/u/1455095?v=4?s=100" width="100px;" alt="Romain Brault"/><br /><sub><b>Romain Brault</b></sub></a><br /><a href="#infra-RomainBrault" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/whiteprints/whiteprints/commits?author=RomainBrault" title="Tests">⚠️</a> <a href="https://github.com/whiteprints/whiteprints/commits?author=RomainBrault" title="Code">💻</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
## Licensing
The _[Python]_ **code** of this project is distributed under license [GPL-3.0-or-later].
In case of doubt, please check the [SPDX] header of each individual source code file.
[Python]: https://www.python.org/
[SPDX]: https://spdx.dev/
[REUSE]: https://reuse.software/
[uv]: https://docs.astral.sh/uv/
[Tox]: https://tox.wiki/
[Pytest]: https://docs.pytest.org/en/stable/
[Sphinx]: https://www.sphinx-doc.org/en/master/index.html
[PyPI]: https://pypi.org/
[ReadTheDocs]: https://about.readthedocs.com/
[CodeCov]: https://about.codecov.io/
[GPL-3.0-or-later]: https://spdx.org/licenses/GPL-3.0-or-later
[MIT-0]: https://spdx.org/licenses/MIT-0
[GitHub]:https://github.com/
Raw data
{
"_id": null,
"home_page": null,
"name": "whiteprints",
"maintainer": "Romain Brault",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "Python",
"author": "Romain Brault",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5e/c0/5dbf1c3c146af01b2b2914166aa66590a5995471efac1b2d450a61fdbeb8/whiteprints-0.10.2.tar.gz",
"platform": null,
"description": "<!--\n\nSPDX-FileCopyrightText: \u00a9 2024 The \"Whiteprints\" contributors <whiteprints@pm.me>\n\nSPDX-License-Identifier: CC-BY-NC-SA-4.0\n-->\n\n# Whiteprints\n\n\n<div align=\"center\">\n <p>\n <em>\n A Copier-based cookiecutter for creating Python projects managed by uv.\n </em>\n </p>\n <p>\n <a href=\"https://www.python.org\"><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/whiteprints.svg?logo=Python&logoColor=ffd43b\"/></a>\n <a href=\"https://pypi.org/project/whiteprints\"><img alt=\"PyPI - Project Version\" src=\"https://img.shields.io/pypi/v/whiteprints.svg?logo=PyPI&logoColor=ffd43b\"/></a>\n <a href=\"https://spdx.org/licenses/GPL-3.0-or-later\"><img alt=\"license badge\" src=\"https://img.shields.io/badge/\ud83d\udcdd_License-GPL--3.0--or--later-4CAF50.svg\"/></a>\n <a href=\"https://github.com/whiteprints/whiteprints/discussions\"><img alt=\"GitHub Discussions\" src=\"https://img.shields.io/github/discussions/whiteprints/whiteprints.svg?logo=GitHub\"></a>\n <a href=\"https://spdx.dev/learn/areas-of-interest/licensing/\"><img alt=\"SPDX Licensing\" src=\"https://img.shields.io/badge/SPDX-licensing-0080FF.svg?logo=SPDX\"/></a>\n <a href='https://readthedocs.org/projects/whiteprints/'><img src='https://readthedocs.org/projects/whiteprints/badge/?version=latest' alt='Documentation Status' /></a>\n <a href=\"https://www.contributor-covenant.org/version/2/1/code_of_conduct/\"><img alt=\"contributor covenant badge\" src=\"https://img.shields.io/badge/Contributor_Covenant-2.1-4BAAAA.svg?logo=contributorcovenant\"/></a>\n <a href=\"https://codecov.io/gh/whiteprints/whiteprints\" ><img alt=\"CodeCov code coverage\" src=\"https://codecov.io/gh/whiteprints/whiteprints/graph/badge.svg?token=YrFGtQ5D5F\"/></a>\n <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n <a href=\"https://github.com/whiteprints/whiteprints?tab=readme-ov-file#contributors\" ><img alt=\"All Contributors\" src=\"https://img.shields.io/github/all-contributors/whiteprints/whiteprints?color=ee8449\\\"/></a>\n <!-- ALL-CONTRIBUTORS-BADGE:END -->\n </p>\n</div>\n\n## Table of contents\n\n- [Background](#background)\n- [Highlights](#highlights)\n- [Install](#install)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [Licensing](#licensing)\n\n## Background\n\nwhiteprints is a command line to generate [Python] projects managed by [uv].\n\nThis is currently for my personal use, the documentation needs to be vastly\nimproved. However if you like the project feel free to use it, ask me questions\nand even contribute \ud83d\ude0a.\n\n## Highlights\n\n- Managed by [uv]\n- [Tox], [Pytest] and [Sphinx] for the development\n- Template for [GitHub] with actions to publish to [PyPI], [ReadTheDocs] and\n [CodeCov]\n\nThe whiteprint command line is under [GPL-3.0-or-later] license, however the\ncode templates used to generate the code are under [MIT-0] license.\n\n\n### Try it!\n\nAll you need is a working `uv`. If you don't already have it just open a\nterminal and run:\n\n- On macOS and Linux:\n ```console\n curl -LsSf https://astral.sh/uv/install.sh | sh\n ```\n- On Windows:\n ```console\n powershell -c \"irm https://astral.sh/uv/install.ps1 | iex\"\n ```\n\nThen just run whiteprints with uvx:\n\n```\nuvx whiteprints init my_awesome_project\n```\nAnswer a few questions and you're ready to go \ud83d\ude80.\n\nThis will create a directory named `my_awesome_project` containing your [Python] project.\n\nTo generate a [GitHub] template please look at the command line help\n\n```\nuvx whiteprints init --help\n```\n\nYou may also have a look at the [Documentation](https://whiteprints.readthedocs.io/en/stable/)\n\n## Documentation\n\nSee: https://whiteprints.readthedocs.io/en/stable/.\n\n## Install\n\nSee [INSTALL.md](https://github.com/whiteprints/whiteprints/blob/main/INSTALL.md).\n\n## Maintainers\n\nSee [MAINTAINERS.md](https://github.com/whiteprints/whiteprints/blob/main/MAINTAINERS.md).\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/whiteprints/whiteprints/blob/main/CONTRIBUTING.md).\n\n## Contributors\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/RomainBrault\"><img src=\"https://avatars.githubusercontent.com/u/1455095?v=4?s=100\" width=\"100px;\" alt=\"Romain Brault\"/><br /><sub><b>Romain Brault</b></sub></a><br /><a href=\"#infra-RomainBrault\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"https://github.com/whiteprints/whiteprints/commits?author=RomainBrault\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/whiteprints/whiteprints/commits?author=RomainBrault\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n## Licensing\n\nThe _[Python]_ **code** of this project is distributed under license [GPL-3.0-or-later].\n\nIn case of doubt, please check the [SPDX] header of each individual source code file.\n\n[Python]: https://www.python.org/\n[SPDX]: https://spdx.dev/\n[REUSE]: https://reuse.software/\n[uv]: https://docs.astral.sh/uv/\n[Tox]: https://tox.wiki/\n[Pytest]: https://docs.pytest.org/en/stable/\n[Sphinx]: https://www.sphinx-doc.org/en/master/index.html\n[PyPI]: https://pypi.org/\n[ReadTheDocs]: https://about.readthedocs.com/\n[CodeCov]: https://about.codecov.io/\n[GPL-3.0-or-later]: https://spdx.org/licenses/GPL-3.0-or-later\n[MIT-0]: https://spdx.org/licenses/MIT-0\n[GitHub]:https://github.com/\n",
"bugtrack_url": null,
"license": null,
"summary": "A Copier-based cookiecutter for creating Python projects managed by uv.",
"version": "0.10.2",
"project_urls": {
"changelog": "https://github.com/whiteprints/whiteprints/releases",
"discussions": "https://github.com/whiteprints/whiteprints/discussions",
"documentation": "https://github.com/whiteprints/whiteprints",
"download": "https://github.com/whiteprints/whiteprints/releases",
"homepage": "https://github.com/whiteprints/whiteprints",
"integration": "https://github.com/whiteprints/whiteprints/actions",
"issues": "https://github.com/whiteprints/whiteprints/issues",
"pypi": "https://pypi.org/project/whiteprints",
"repository": "https://github.com/whiteprints/whiteprints"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d000829d899b55e7d4a4fa25efbd52bf1a815a0557e5ee51b09b83d5059ca96",
"md5": "a4986d0e22d81234bf3e10106ca5b10a",
"sha256": "d27940942885961515b9994e33a40fbaf26dc6468dae2cfdca00ac28232f49e3"
},
"downloads": -1,
"filename": "whiteprints-0.10.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a4986d0e22d81234bf3e10106ca5b10a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 31809,
"upload_time": "2024-10-21T10:09:04",
"upload_time_iso_8601": "2024-10-21T10:09:04.499481Z",
"url": "https://files.pythonhosted.org/packages/1d/00/0829d899b55e7d4a4fa25efbd52bf1a815a0557e5ee51b09b83d5059ca96/whiteprints-0.10.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ec05dbf1c3c146af01b2b2914166aa66590a5995471efac1b2d450a61fdbeb8",
"md5": "f74610a47ffac2cc15eb27fd9b61b2d1",
"sha256": "2a4d2aeccbff03d4c95b3e5edaf93c2ea2855b26e37d1030b09516cb135bcfa7"
},
"downloads": -1,
"filename": "whiteprints-0.10.2.tar.gz",
"has_sig": false,
"md5_digest": "f74610a47ffac2cc15eb27fd9b61b2d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 25496,
"upload_time": "2024-10-21T10:09:05",
"upload_time_iso_8601": "2024-10-21T10:09:05.773348Z",
"url": "https://files.pythonhosted.org/packages/5e/c0/5dbf1c3c146af01b2b2914166aa66590a5995471efac1b2d450a61fdbeb8/whiteprints-0.10.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 10:09:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whiteprints",
"github_project": "whiteprints",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "whiteprints"
}
