## toolchest
[](https://pypi.python.org/pypi/toolchest)
[](https://github.com/release-depot/toolchest/actions)
[](https://toolchest.readthedocs.io/en/latest/?badge=latest)
Toolchest is a collection of generally useful functions that can be reused in
various settings.
Find the most recent documentation at https://toolchest.readthedocs.io.
## Notes
This library only supports python 3. Some features may still work with python 2.7 but not all of the
syntax and features may be compatible. Prettytable can be used, but is optional.
## Installing
toolchest is available on PyPI; it can be installed by running::
pip install toolchest
Alternatively, one could also clone this repository and run::
pip install --editable .
## Development
toolchest supports both standard python virtual environment setups and pipenv,
which is integrated into our Makefile. To set up a pipenv-based development
enironment, you can simply run::
make dev
This will install our dev environment for the package via pipenv. It is installed
with --user, so it does not affect your site-packages. Pipenv creates a unique virtualenv
for us, which you can activate via::
pipenv shell
See the [pipenv documentation](https://pipenv.pypa.io/en/latest/) for more detail.
If you prefer to use pip directly in your venv, specify the following
requirements files:
- requirements.txt
- test-requirements.txt
There is also a dist-requirements.txt, if you will be building the project
for distribution.
## Documentation
To build the documentation on your checkout, simply run::
make docs
Alternatively, to install via pip directly, include the following
requirements files:
- requirements.txt
- docs-requirements.txt
## Contributing
All new code should include tests that exercise the code and prove that it
works, or fixes the bug you are trying to fix. Any Pull Request without tests
will not be accepted. See CONTRIBUTING.rst for more details.
## Building
If you wish to build a local package for testing at any time, you can simply
run::
make dist
this will build a package with a .dev extension that you can install for testing
and verification.
## Acknowledgements
This code contains a derivative work of 'rpmvercmp' from RPM 4.14.1.
Raw data
{
"_id": null,
"home_page": "https://github.com/release-depot/toolchest",
"name": "toolchest",
"maintainer": "Lon Hohberger",
"docs_url": null,
"requires_python": "",
"maintainer_email": "lon@metamorphism.com",
"keywords": "toolchest",
"author": "Red Hat",
"author_email": "lhh@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/dd/6b/015d9b247871b99cb99f47a3e73b1f2e94b9beb9f543867f009f50ca2e48/toolchest-0.0.13.tar.gz",
"platform": null,
"description": "## toolchest\n\n\n[](https://pypi.python.org/pypi/toolchest)\n[](https://github.com/release-depot/toolchest/actions)\n[](https://toolchest.readthedocs.io/en/latest/?badge=latest)\n\nToolchest is a collection of generally useful functions that can be reused in\nvarious settings.\n\nFind the most recent documentation at https://toolchest.readthedocs.io.\n\n## Notes\n\nThis library only supports python 3. Some features may still work with python 2.7 but not all of the\nsyntax and features may be compatible. Prettytable can be used, but is optional.\n\n\n## Installing\n\ntoolchest is available on PyPI; it can be installed by running::\n\n pip install toolchest\n\nAlternatively, one could also clone this repository and run::\n\n pip install --editable .\n\n\n## Development\n\ntoolchest supports both standard python virtual environment setups and pipenv,\nwhich is integrated into our Makefile. To set up a pipenv-based development\nenironment, you can simply run::\n\n make dev\n\nThis will install our dev environment for the package via pipenv. It is installed\nwith --user, so it does not affect your site-packages. Pipenv creates a unique virtualenv\nfor us, which you can activate via::\n\n pipenv shell\n\nSee the [pipenv documentation](https://pipenv.pypa.io/en/latest/) for more detail.\n\nIf you prefer to use pip directly in your venv, specify the following\nrequirements files:\n\n - requirements.txt\n - test-requirements.txt\n\nThere is also a dist-requirements.txt, if you will be building the project\nfor distribution.\n\n## Documentation\n\nTo build the documentation on your checkout, simply run::\n\n make docs\n\nAlternatively, to install via pip directly, include the following\nrequirements files:\n\n - requirements.txt\n - docs-requirements.txt\n\n## Contributing\n\nAll new code should include tests that exercise the code and prove that it\nworks, or fixes the bug you are trying to fix. Any Pull Request without tests\nwill not be accepted. See CONTRIBUTING.rst for more details.\n\n## Building\n\nIf you wish to build a local package for testing at any time, you can simply\nrun::\n\n make dist\n\nthis will build a package with a .dev extension that you can install for testing\nand verification.\n\n## Acknowledgements\n\nThis code contains a derivative work of 'rpmvercmp' from RPM 4.14.1.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "toolchest is a collection of generic functions for release-depot",
"version": "0.0.13",
"project_urls": {
"Bug Tracker": "https://github.com/release-depot/toolchest/issues",
"Homepage": "https://github.com/release-depot/toolchest"
},
"split_keywords": [
"toolchest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc0086a1314cc4c609bfb436be504410abfb6752b1a821c30549885aea7a13bf",
"md5": "19165dea4107357701fc35ffc2e54d38",
"sha256": "f0fbdc5ccece0debc4a0342b6814167aa31af131d70d9e5770d6db437bd35900"
},
"downloads": -1,
"filename": "toolchest-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "19165dea4107357701fc35ffc2e54d38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 29415,
"upload_time": "2022-06-16T14:47:28",
"upload_time_iso_8601": "2022-06-16T14:47:28.002277Z",
"url": "https://files.pythonhosted.org/packages/dc/00/86a1314cc4c609bfb436be504410abfb6752b1a821c30549885aea7a13bf/toolchest-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd6b015d9b247871b99cb99f47a3e73b1f2e94b9beb9f543867f009f50ca2e48",
"md5": "664223242bdce25c69571adf5145ff28",
"sha256": "47767611a277ca1c0fd7ba66ba6859c608b48d8176489f85885768eb17892465"
},
"downloads": -1,
"filename": "toolchest-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "664223242bdce25c69571adf5145ff28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37250,
"upload_time": "2022-06-16T14:47:29",
"upload_time_iso_8601": "2022-06-16T14:47:29.271091Z",
"url": "https://files.pythonhosted.org/packages/dd/6b/015d9b247871b99cb99f47a3e73b1f2e94b9beb9f543867f009f50ca2e48/toolchest-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-16 14:47:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "release-depot",
"github_project": "toolchest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "toolchest"
}
JSON
