| Name | example-package-hchiam JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | |
| Summary | A sample Python project |
| upload_time | 2022-12-16 07:58:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | Copyright (c) 2022 Howard Chiam Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sample
setuptools
development
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# My notes:
Register for an account on test.pypi, and get an API token.
https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives
```sh
# update the pyproject.toml [project] name (to be the package name)
python3 -m pip install --upgrade build
# go to folder that contains pyproject.toml and run this:
python3 -m build
```
https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives
```sh
python3 -m pip install --upgrade twine
# go folder containing dist and run this:
python3 -m twine upload --repository testpypi dist/*
# for username, literally enter username as __token__
# for password, use your API key from your test.pypi account, including pypi- prefix
# https://test.pypi.org/search/?q=example_package_hchiam
# https://test.pypi.org/project/example-package-hchiam/
```
(more steps if you want to test the test-only version of your package: https://test.pypi.org/project/example-package-hchiam/)
To upload the production-ready version of your package: (pypi requires a separate registration and API key set up from the test.pypi site)
```sh
python3 -m twine upload dist/*
# for username, still literaly enter __token__
# for password, use your other API key from your pypi account, including pypi- prefix
# https://pypi.org/search/?q=example_package_hchiam
# https://pypi.org/project/example-package-hchiam/
```
https://pypi.org/project/example-package-hchiam/
```sh
# python3 -m pip install [your-package]
python3 -m pip install example_package_hchiam
```
`/tests/test_example.py` shows a good example of how the package will be used by users, where you can see a method from an inner/non-`__init__` file, e.g.:
```py
from example_package_hchiam.example import add_one
```
## Streamlined thereafter:
```sh
# update code
# update pyproject.toml version number
# remove the old .whl and .gz files
rm -rf dist
python3 -m build
python3 -m twine upload --repository testpypi dist/*
python3 -m twine upload dist/*
python3 -m pip install example_package_hchiam
```
Raw data
{
"_id": null,
"home_page": "",
"name": "example-package-hchiam",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "\"A. Great Maintainer\" <maintainer@example.com>",
"keywords": "sample,setuptools,development",
"author": "",
"author_email": "\"A. Random Developer\" <author@example.com>",
"download_url": "https://files.pythonhosted.org/packages/6c/54/9188a0c4e94abc3aa218c39d1e33c42210b9adf92464eee348ed479a6058/example_package_hchiam-0.0.3.tar.gz",
"platform": null,
"description": "# My notes:\n\nRegister for an account on test.pypi, and get an API token.\n\nhttps://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives\n\n```sh\n# update the pyproject.toml [project] name (to be the package name)\npython3 -m pip install --upgrade build\n# go to folder that contains pyproject.toml and run this:\npython3 -m build\n```\n\nhttps://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives\n\n```sh\npython3 -m pip install --upgrade twine\n# go folder containing dist and run this:\npython3 -m twine upload --repository testpypi dist/*\n# for username, literally enter username as __token__\n# for password, use your API key from your test.pypi account, including pypi- prefix\n# https://test.pypi.org/search/?q=example_package_hchiam\n# https://test.pypi.org/project/example-package-hchiam/\n```\n\n(more steps if you want to test the test-only version of your package: https://test.pypi.org/project/example-package-hchiam/)\n\nTo upload the production-ready version of your package: (pypi requires a separate registration and API key set up from the test.pypi site)\n\n```sh\npython3 -m twine upload dist/*\n# for username, still literaly enter __token__\n# for password, use your other API key from your pypi account, including pypi- prefix\n# https://pypi.org/search/?q=example_package_hchiam\n# https://pypi.org/project/example-package-hchiam/\n```\n\nhttps://pypi.org/project/example-package-hchiam/\n\n```sh\n# python3 -m pip install [your-package]\npython3 -m pip install example_package_hchiam\n```\n\n`/tests/test_example.py` shows a good example of how the package will be used by users, where you can see a method from an inner/non-`__init__` file, e.g.:\n\n```py\nfrom example_package_hchiam.example import add_one\n```\n\n## Streamlined thereafter:\n\n```sh\n# update code\n# update pyproject.toml version number\n# remove the old .whl and .gz files\nrm -rf dist\npython3 -m build\npython3 -m twine upload --repository testpypi dist/*\npython3 -m twine upload dist/*\n\npython3 -m pip install example_package_hchiam\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2022 Howard Chiam Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A sample Python project",
"version": "0.0.3",
"split_keywords": [
"sample",
"setuptools",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c96e07fd9e6a9eebdf974a11bcad5aed",
"sha256": "16574a909d5c96df16017991738bd068fefc3b00bdbb4ed343667fbdc66ac596"
},
"downloads": -1,
"filename": "example_package_hchiam-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c96e07fd9e6a9eebdf974a11bcad5aed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4569,
"upload_time": "2022-12-16T07:58:54",
"upload_time_iso_8601": "2022-12-16T07:58:54.229386Z",
"url": "https://files.pythonhosted.org/packages/96/f1/b94b4a06e193a085a3634ab4d855292e3e8adc4f265f9a8206e336c3afda/example_package_hchiam-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "987b2deda6cfa4eca8e2715b0a048d5c",
"sha256": "9ac9dca134e8f693eac18865170f3553b80d4c243b19061e8bb0125a9f4ac297"
},
"downloads": -1,
"filename": "example_package_hchiam-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "987b2deda6cfa4eca8e2715b0a048d5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4434,
"upload_time": "2022-12-16T07:58:55",
"upload_time_iso_8601": "2022-12-16T07:58:55.913121Z",
"url": "https://files.pythonhosted.org/packages/6c/54/9188a0c4e94abc3aa218c39d1e33c42210b9adf92464eee348ed479a6058/example_package_hchiam-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-16 07:58:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "example-package-hchiam"
}
