# PyKitReWi
A sample project that exists as an aid to the [Python Packaging User
Guide][packaging guide]'s [Tutorial on Packaging and Distributing
Projects][distribution tutorial].
This project does not aim to cover best practices for Python project
development as a whole. For example, it does not provide guidance or tool
recommendations for version control, documentation, or testing.
[The source for this project is available here][src].
Most of the configuration for a Python project is done in the `setup.py` file,
an example of which is included in this project. You should edit this file
accordingly to adapt this sample project to your needs.
----
This is the README file for the project.
The file should use UTF-8 encoding and can be written using
[reStructuredText][rst] or [markdown][md use] with the appropriate [key set][md
use]. It will be used to generate the project webpage on PyPI and will be
displayed as the project homepage on common code-hosting services, and should be
written for that purpose.
Typical contents for this file would include an overview of the project, basic
usage examples, etc. Generally, including the project changelog in here is not a
good idea, although a simple “What's New” section for the most recent version
may be appropriate.
[packaging guide]: https://packaging.python.org
[distribution tutorial]: https://packaging.python.org/tutorials/packaging-projects/
[src]: https://github.com/Re-Wi/PyKitReWi
[rst]: http://docutils.sourceforge.net/rst.html
[md]: https://tools.ietf.org/html/rfc7764#section-3.5 "CommonMark variant"
[md use]: https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
# Packaging your project
- https://packaging.python.org/en/latest/guides/section-build-and-publish/
Before you can build wheels and sdists for your project, you’ll need to install the build package:
```shell
py -m pip install build
```
Source distributions
Minimally, you should create a Source Distribution:
```shell
py -m build --sdist
```
# Wheels
## Pure Python Wheels
Pure Python Wheels contain no compiled extensions, and therefore only require a single Python wheel.
To build the wheel:
```shell
py -m build --wheel
```
## Platform Wheels
Platform Wheels are wheels that are specific to a certain platform like Linux, macOS, or Windows, usually due to
containing compiled extensions.
```shell
py -m build --wheel
```
# 上传
- https://zhuanlan.zhihu.com/p/682004873
## 上传到TestPyPI
```shell
py -m twine upload --repository testpypi dist/*
```
## 上传到PyPI
```shell
py -m twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Re-Wi/PyKitReWi",
"name": "PyKitReWi",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": null,
"keywords": "sample, setuptools, development",
"author": "RejoiceWindow",
"author_email": "RejoiceWindow@yeah.net",
"download_url": "https://files.pythonhosted.org/packages/db/3a/2f836c9d9d137b24901353e17c048570efca561dc590607d4a92d1eab401/pykitrewi-0.0.4.tar.gz",
"platform": null,
"description": "# PyKitReWi\r\n\r\n![Python Logo](https://www.python.org/static/community_logos/python-logo.png \"Sample inline image\")\r\n\r\nA sample project that exists as an aid to the [Python Packaging User\r\nGuide][packaging guide]'s [Tutorial on Packaging and Distributing\r\nProjects][distribution tutorial].\r\n\r\nThis project does not aim to cover best practices for Python project\r\ndevelopment as a whole. For example, it does not provide guidance or tool\r\nrecommendations for version control, documentation, or testing.\r\n\r\n[The source for this project is available here][src].\r\n\r\nMost of the configuration for a Python project is done in the `setup.py` file,\r\nan example of which is included in this project. You should edit this file\r\naccordingly to adapt this sample project to your needs.\r\n\r\n----\r\n\r\nThis is the README file for the project.\r\n\r\nThe file should use UTF-8 encoding and can be written using\r\n[reStructuredText][rst] or [markdown][md use] with the appropriate [key set][md\r\nuse]. It will be used to generate the project webpage on PyPI and will be\r\ndisplayed as the project homepage on common code-hosting services, and should be\r\nwritten for that purpose.\r\n\r\nTypical contents for this file would include an overview of the project, basic\r\nusage examples, etc. Generally, including the project changelog in here is not a\r\ngood idea, although a simple \u201cWhat's New\u201d section for the most recent version\r\nmay be appropriate.\r\n\r\n[packaging guide]: https://packaging.python.org\r\n\r\n[distribution tutorial]: https://packaging.python.org/tutorials/packaging-projects/\r\n\r\n[src]: https://github.com/Re-Wi/PyKitReWi\r\n\r\n[rst]: http://docutils.sourceforge.net/rst.html\r\n\r\n[md]: https://tools.ietf.org/html/rfc7764#section-3.5 \"CommonMark variant\"\r\n\r\n[md use]: https://packaging.python.org/specifications/core-metadata/#description-content-type-optional\r\n\r\n# Packaging your project\r\n\r\n- https://packaging.python.org/en/latest/guides/section-build-and-publish/\r\n\r\nBefore you can build wheels and sdists for your project, you\u2019ll need to install the build package:\r\n\r\n```shell\r\npy -m pip install build\r\n```\r\n\r\nSource distributions\r\nMinimally, you should create a Source Distribution:\r\n\r\n```shell\r\npy -m build --sdist\r\n```\r\n\r\n# Wheels\r\n\r\n## Pure Python Wheels\r\n\r\nPure Python Wheels contain no compiled extensions, and therefore only require a single Python wheel.\r\n\r\nTo build the wheel:\r\n\r\n```shell\r\npy -m build --wheel\r\n```\r\n\r\n## Platform Wheels\r\n\r\nPlatform Wheels are wheels that are specific to a certain platform like Linux, macOS, or Windows, usually due to\r\ncontaining compiled extensions.\r\n\r\n```shell\r\npy -m build --wheel\r\n```\r\n\r\n# \u4e0a\u4f20\r\n\r\n- https://zhuanlan.zhihu.com/p/682004873\r\n\r\n## \u4e0a\u4f20\u5230TestPyPI\r\n\r\n```shell\r\npy -m twine upload --repository testpypi dist/*\r\n```\r\n\r\n## \u4e0a\u4f20\u5230PyPI\r\n\r\n```shell\r\npy -m twine upload dist/*\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A PyKitReWi Python project",
"version": "0.0.4",
"project_urls": {
"Bug Reports": "https://github.com/Re-Wi/PyKitReWi/issues",
"Funding": "https://donate.pypi.org",
"Homepage": "https://github.com/Re-Wi/PyKitReWi",
"Say Thanks!": "http://saythanks.io/to/example",
"Source": "https://github.com/Re-Wi/PyKitReWi/"
},
"split_keywords": [
"sample",
" setuptools",
" development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "778b9fed2d908a040d961ebf3fbeed75ab817d2cbd80d34bc1af97e73a46d454",
"md5": "c58140f0c74cf546f0440fd7d9bc6fd1",
"sha256": "c86c1f80608fb0b0bfcf4cc07c7c1dc0c83844cd851d71ed8c88548572bb7e8a"
},
"downloads": -1,
"filename": "PyKitReWi-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c58140f0c74cf546f0440fd7d9bc6fd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 42991,
"upload_time": "2024-10-16T03:45:23",
"upload_time_iso_8601": "2024-10-16T03:45:23.366809Z",
"url": "https://files.pythonhosted.org/packages/77/8b/9fed2d908a040d961ebf3fbeed75ab817d2cbd80d34bc1af97e73a46d454/PyKitReWi-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db3a2f836c9d9d137b24901353e17c048570efca561dc590607d4a92d1eab401",
"md5": "3b5afbda60a9f127f6882af91cb0cc49",
"sha256": "c38a45aa8d70a1a8e1c40b2447a2ff8a908ba47626184b354107dd1759760454"
},
"downloads": -1,
"filename": "pykitrewi-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "3b5afbda60a9f127f6882af91cb0cc49",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 31453,
"upload_time": "2024-10-16T03:45:25",
"upload_time_iso_8601": "2024-10-16T03:45:25.016762Z",
"url": "https://files.pythonhosted.org/packages/db/3a/2f836c9d9d137b24901353e17c048570efca561dc590607d4a92d1eab401/pykitrewi-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 03:45:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Re-Wi",
"github_project": "PyKitReWi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "loguru",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "PySide6",
"specs": []
},
{
"name": "pytz",
"specs": []
},
{
"name": "jinja2",
"specs": []
},
{
"name": "pytz",
"specs": []
}
],
"lcname": "pykitrewi"
}
JSON
