| Name | zzz233 JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | a minimalistic python package |
| upload_time | 2024-06-27 15:00:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
toy
package
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# zzz233
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fhusisy%2Fzzz233?ref=badge_shield)
**WARNING**: this package is only to demonstrate how to build a minimal python package. Any functions provided in this package could be changed in an incompatible way in the future. DO NOT use it in production.
A minimal python package.
1. download locally
* clone repository: `git clone git@github.com:husisy/zzz233.git`
* download zip: `wget xxx`
* download released package: TODO
2. install
* install from pypi: `pip install zzz233`
* install locally: `pip install .`
* (for developer) install locally: `pip install ".[dev]"`
* (for documentation developer) install locally: `pip install ".[doc]"`
* install from github: `pip install git+https://github.com/husisy/zzz233.git`
3. uninstall `pip uninstall zzz233`
4. scrips
* run in command line: `zzz233`
5. unittest: download locally
* `pytest`
* (require developer install locally) coverage `pytest --cov=python/zzz233`
6. documentation
* build locally: `mkdocs serve`
* website: `https://husisy.github.io/zzz233/`
7. github action (CI/CD)
* build documentation, enable github page (select deploy from actions)
* unittest
8. reading material
* [github/setuptools_scm](https://github.com/pypa/setuptools_scm) (Source Code Management)
* [setuptools/pyproject-config](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html)
* distribute package to pypi
TODO make a clear table
usage
```Python
# a dummy example
from zzz233 import from_pickle, to_pickle
a = 233
to_pickle(a=a)
assert from_pickle('a')==a
```
TODO
1. [ ] semantic versioning [link](https://semver.org/)
## development
new environment
```bash
micromamba create -n zzz233 python
micromamba activate zzz233
pip install .
# pip install -e ".[dev]"
mkdocs serve
```
publish to pypi
```bash
# cleanup the branch and tag the latest commit with a valid version
# otherwise the build will fail
rm -rf ./dist
pip install build
python -m build
# testpypi
# setup testpypi apikey $HOME/.pypirc (the username is "__token__")
twine upload --repository testpypi dist/*
# --repository-url https://test.pypi.org/legacy/
pip uninstall zzz233
pip install --upgrade -i https://test.pypi.org/simple/ zzz233
# pypi
# --repository-url https://upload.pypi.org/legacy/
```
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fhusisy%2Fzzz233?ref=badge_large)
Raw data
{
"_id": null,
"home_page": null,
"name": "zzz233",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "toy package",
"author": null,
"author_email": "husisy <donot@mail.me>",
"download_url": "https://files.pythonhosted.org/packages/bf/5c/cbd8703972ce65222725cfa270338b0365c66c1508af7f4ea4cb89c2eb64/zzz233-0.4.0.tar.gz",
"platform": null,
"description": "# zzz233\n\n[](https://app.fossa.com/projects/git%2Bgithub.com%2Fhusisy%2Fzzz233?ref=badge_shield)\n\n**WARNING**: this package is only to demonstrate how to build a minimal python package. Any functions provided in this package could be changed in an incompatible way in the future. DO NOT use it in production.\n\nA minimal python package.\n\n1. download locally\n * clone repository: `git clone git@github.com:husisy/zzz233.git`\n * download zip: `wget xxx`\n * download released package: TODO\n2. install\n * install from pypi: `pip install zzz233`\n * install locally: `pip install .`\n * (for developer) install locally: `pip install \".[dev]\"`\n * (for documentation developer) install locally: `pip install \".[doc]\"`\n * install from github: `pip install git+https://github.com/husisy/zzz233.git`\n3. uninstall `pip uninstall zzz233`\n4. scrips\n * run in command line: `zzz233`\n5. unittest: download locally\n * `pytest`\n * (require developer install locally) coverage `pytest --cov=python/zzz233`\n6. documentation\n * build locally: `mkdocs serve`\n * website: `https://husisy.github.io/zzz233/`\n7. github action (CI/CD)\n * build documentation, enable github page (select deploy from actions)\n * unittest\n8. reading material\n * [github/setuptools_scm](https://github.com/pypa/setuptools_scm) (Source Code Management)\n * [setuptools/pyproject-config](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html)\n * distribute package to pypi\n\nTODO make a clear table\n\nusage\n\n```Python\n# a dummy example\nfrom zzz233 import from_pickle, to_pickle\na = 233\nto_pickle(a=a)\nassert from_pickle('a')==a\n```\n\nTODO\n\n1. [ ] semantic versioning [link](https://semver.org/)\n\n## development\n\nnew environment\n\n```bash\nmicromamba create -n zzz233 python\nmicromamba activate zzz233\n\npip install .\n# pip install -e \".[dev]\"\nmkdocs serve\n```\n\npublish to pypi\n\n```bash\n# cleanup the branch and tag the latest commit with a valid version\n# otherwise the build will fail\nrm -rf ./dist\npip install build\npython -m build\n\n# testpypi\n# setup testpypi apikey $HOME/.pypirc (the username is \"__token__\")\ntwine upload --repository testpypi dist/*\n# --repository-url https://test.pypi.org/legacy/\npip uninstall zzz233\npip install --upgrade -i https://test.pypi.org/simple/ zzz233\n\n# pypi\n# --repository-url https://upload.pypi.org/legacy/\n```\n\n## License\n\n[](https://app.fossa.com/projects/git%2Bgithub.com%2Fhusisy%2Fzzz233?ref=badge_large)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "a minimalistic python package",
"version": "0.4.0",
"project_urls": {
"Documentation": "https://husisy.github.io/zzz233/",
"Homepage": "https://github.com/husisy/zzz233"
},
"split_keywords": [
"toy",
"package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed4f2e31ee0c0f8cab210362e61368a6f32125e39f4c360842995ca98e52f428",
"md5": "0a951a1f06773ef1af838c4ebf9ce465",
"sha256": "88b12dece2d3367d643f2b64f8ba03dbb74b8bb36294dd9d7adfa368d9a81358"
},
"downloads": -1,
"filename": "zzz233-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a951a1f06773ef1af838c4ebf9ce465",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6496,
"upload_time": "2024-06-27T15:00:32",
"upload_time_iso_8601": "2024-06-27T15:00:32.602673Z",
"url": "https://files.pythonhosted.org/packages/ed/4f/2e31ee0c0f8cab210362e61368a6f32125e39f4c360842995ca98e52f428/zzz233-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf5ccbd8703972ce65222725cfa270338b0365c66c1508af7f4ea4cb89c2eb64",
"md5": "e378d87d666147c08261a7b644147469",
"sha256": "8c56c34b54dee853a05b6ff021a84788b8a7daebd7df923c92a92073328fcdd1"
},
"downloads": -1,
"filename": "zzz233-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "e378d87d666147c08261a7b644147469",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9317,
"upload_time": "2024-06-27T15:00:33",
"upload_time_iso_8601": "2024-06-27T15:00:33.955899Z",
"url": "https://files.pythonhosted.org/packages/bf/5c/cbd8703972ce65222725cfa270338b0365c66c1508af7f4ea4cb89c2eb64/zzz233-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 15:00:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "husisy",
"github_project": "zzz233",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zzz233"
}
