| Name | czekitout JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | None |
| Summary | Contains a collection of functions that facilitate validation, and type-conversions, with useful error messages when exceptions are thrown. |
| upload_time | 2025-10-24 21:48:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
type checking
type conversion
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# Check It Out (CzekItOut)
[](https://github.com/mrfitzpa/czekitout/actions/workflows/test_library.yml)
[](https://github.com/mrfitzpa/czekitout/actions/workflows/measure_code_coverage.yml)
[](https://mrfitzpa.github.io/czekitout)
[](https://pypi.org/project/czekitout)
[](https://anaconda.org/conda-forge/czekitout)
[](https://www.gnu.org/licenses/gpl-3.0)
`czekitout` is a Python library that contains a collection of functions that
facilitate validation, and type-conversions, with useful error messages when
exceptions are thrown.
Visit the `czekitout` [website](https://mrfitzpa.github.io/czekitout) for a web
version of the installation instructions, the reference guide, and the examples
archive.
The source code can be found in the [`czekitout` GitHub
repository](https://github.com/mrfitzpa/czekitout).
## Table of contents
- [Instructions for installing and uninstalling
`czekitout`](#instructions-for-installing-and-uninstalling-czekitout)
- [Installing `czekitout`](#installing-czekitout)
- [Installing `czekitout` using
`pip`](#installing-czekitout-using-pip)
- [Installing `czekitout` using
`conda`](#installing-czekitout-using-conda)
- [Uninstalling `czekitout`](#uninstalling-czekitout)
- [Learning how to use `czekitout`](#learning-how-to-use-czekitout)
## Instructions for installing and uninstalling `czekitout`
### Installing `czekitout`
For all installation scenarios, first open up the appropriate command line
interface. On Unix-based systems, you could open e.g. a terminal. On Windows
systems you could open e.g. an Anaconda Prompt as an administrator.
#### Installing `czekitout` using `pip`
Before installing `czekitout`, make sure that you have activated the (virtual)
environment in which you intend to install said package. After which, simply run
the following command:
pip install czekitout
The above command will install the latest stable version of `czekitout`.
To install the latest development version from the main branch of the [czekitout
GitHub repository](https://github.com/mrfitzpa/czekitout), one must first clone
the repository by running the following command:
git clone https://github.com/mrfitzpa/czekitout.git
Next, change into the root of the cloned repository, and then run the following
command:
pip install .
Note that you must include the period as well. The above command executes a
standard installation of `czekitout`.
Optionally, for additional features in `czekitout`, one can install additional
dependencies upon installing `czekitout`. To install a subset of additional
dependencies (along with the standard installation), run the following command
from the root of the repository:
pip install .[<selector>]
where `<selector>` can be one of the following:
* `tests`: to install the dependencies necessary for running unit tests;
* `examples`: to install the dependencies necessary for executing files stored
in `<root>/examples`, where `<root>` is the root of the repository;
* `docs`: to install the dependencies necessary for documentation generation;
* `all`: to install all of the above optional dependencies.
Alternatively, one can run:
pip install czekitout[<selector>]
elsewhere in order to install the latest stable version of `czekitout`, along
with the subset of additional dependencies specified by `<selector>`.
#### Installing `czekitout` using `conda`
To install `czekitout` using the `conda` package manager, run the following
command:
conda install -c conda-forge czekitout
The above command will install the latest stable version of `czekitout`.
### Uninstalling `czekitout`
If `czekitout` was installed using `pip`, then to uninstall, run the following
command:
pip uninstall czekitout
If `czekitout` was installed using `conda`, then to uninstall, run the following
command:
conda remove czekitout
## Learning how to use `czekitout`
For those new to the `czekitout` library, it is recommended that they take a
look at the [Examples](https://mrfitzpa.github.io/czekitout/examples.html) page,
which contain code examples that show how one can use the `czekitout`
library. While going through the examples, readers can consult the [czekitout
reference
guide](https://mrfitzpa.github.io/czekitout/_autosummary/czekitout.html) to
understand what each line of code is doing.
Raw data
{
"_id": null,
"home_page": null,
"name": "czekitout",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "type checking, type conversion",
"author": null,
"author_email": "Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/32/7e/58947d602d049f3845c6785669e8fbe62373c6e62664ac4af7e982cd6a8a/czekitout-1.2.1.tar.gz",
"platform": null,
"description": "# Check It Out (CzekItOut)\n\n[](https://github.com/mrfitzpa/czekitout/actions/workflows/test_library.yml)\n[](https://github.com/mrfitzpa/czekitout/actions/workflows/measure_code_coverage.yml)\n[](https://mrfitzpa.github.io/czekitout)\n[](https://pypi.org/project/czekitout)\n[](https://anaconda.org/conda-forge/czekitout)\n[](https://www.gnu.org/licenses/gpl-3.0)\n\n`czekitout` is a Python library that contains a collection of functions that\nfacilitate validation, and type-conversions, with useful error messages when\nexceptions are thrown.\n\nVisit the `czekitout` [website](https://mrfitzpa.github.io/czekitout) for a web\nversion of the installation instructions, the reference guide, and the examples\narchive.\n\nThe source code can be found in the [`czekitout` GitHub\nrepository](https://github.com/mrfitzpa/czekitout).\n\n\n\n## Table of contents\n\n- [Instructions for installing and uninstalling\n `czekitout`](#instructions-for-installing-and-uninstalling-czekitout)\n - [Installing `czekitout`](#installing-czekitout)\n - [Installing `czekitout` using\n `pip`](#installing-czekitout-using-pip)\n - [Installing `czekitout` using\n `conda`](#installing-czekitout-using-conda)\n - [Uninstalling `czekitout`](#uninstalling-czekitout)\n- [Learning how to use `czekitout`](#learning-how-to-use-czekitout)\n\n\n\n## Instructions for installing and uninstalling `czekitout`\n\n\n\n### Installing `czekitout`\n\nFor all installation scenarios, first open up the appropriate command line\ninterface. On Unix-based systems, you could open e.g. a terminal. On Windows\nsystems you could open e.g. an Anaconda Prompt as an administrator.\n\n\n\n#### Installing `czekitout` using `pip`\n\nBefore installing `czekitout`, make sure that you have activated the (virtual)\nenvironment in which you intend to install said package. After which, simply run\nthe following command:\n\n pip install czekitout\n\nThe above command will install the latest stable version of `czekitout`.\n\nTo install the latest development version from the main branch of the [czekitout\nGitHub repository](https://github.com/mrfitzpa/czekitout), one must first clone\nthe repository by running the following command:\n\n git clone https://github.com/mrfitzpa/czekitout.git\n\nNext, change into the root of the cloned repository, and then run the following\ncommand:\n\n pip install .\n\nNote that you must include the period as well. The above command executes a\nstandard installation of `czekitout`.\n\nOptionally, for additional features in `czekitout`, one can install additional\ndependencies upon installing `czekitout`. To install a subset of additional\ndependencies (along with the standard installation), run the following command\nfrom the root of the repository:\n\n pip install .[<selector>]\n\nwhere `<selector>` can be one of the following:\n\n* `tests`: to install the dependencies necessary for running unit tests;\n* `examples`: to install the dependencies necessary for executing files stored\n in `<root>/examples`, where `<root>` is the root of the repository;\n* `docs`: to install the dependencies necessary for documentation generation;\n* `all`: to install all of the above optional dependencies.\n\nAlternatively, one can run:\n\n pip install czekitout[<selector>]\n\nelsewhere in order to install the latest stable version of `czekitout`, along\nwith the subset of additional dependencies specified by `<selector>`.\n\n\n\n#### Installing `czekitout` using `conda`\n\nTo install `czekitout` using the `conda` package manager, run the following\ncommand:\n\n conda install -c conda-forge czekitout\n\nThe above command will install the latest stable version of `czekitout`.\n\n\n\n### Uninstalling `czekitout`\n\nIf `czekitout` was installed using `pip`, then to uninstall, run the following\ncommand:\n\n pip uninstall czekitout\n\nIf `czekitout` was installed using `conda`, then to uninstall, run the following\ncommand:\n\n conda remove czekitout\n\n\n\n## Learning how to use `czekitout`\n\nFor those new to the `czekitout` library, it is recommended that they take a\nlook at the [Examples](https://mrfitzpa.github.io/czekitout/examples.html) page,\nwhich contain code examples that show how one can use the `czekitout`\nlibrary. While going through the examples, readers can consult the [czekitout\nreference\nguide](https://mrfitzpa.github.io/czekitout/_autosummary/czekitout.html) to\nunderstand what each line of code is doing.\n",
"bugtrack_url": null,
"license": null,
"summary": "Contains a collection of functions that facilitate validation, and type-conversions, with useful error messages when exceptions are thrown.",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://mrfitzpa.github.io/czekitout",
"Repository": "https://github.com/mrfitzpa/czekitout"
},
"split_keywords": [
"type checking",
" type conversion"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e8c3c79ee4285063d2c2168b9af26eed9ad432ddf6cc409bce1aa104510c0373",
"md5": "0fe69854dc9af12ab677583285a2fa3e",
"sha256": "d6808902d8829b5d0908876ed9f161d26545890d5c129380b3b3749f10430490"
},
"downloads": -1,
"filename": "czekitout-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fe69854dc9af12ab677583285a2fa3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 29350,
"upload_time": "2025-10-24T21:48:34",
"upload_time_iso_8601": "2025-10-24T21:48:34.661672Z",
"url": "https://files.pythonhosted.org/packages/e8/c3/c79ee4285063d2c2168b9af26eed9ad432ddf6cc409bce1aa104510c0373/czekitout-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "327e58947d602d049f3845c6785669e8fbe62373c6e62664ac4af7e982cd6a8a",
"md5": "14b1c2bc48c10cbef834402967848737",
"sha256": "867781b14dda7f6317f29d580216b60e1adf235d0613a0a5a08b6ea2b6af3302"
},
"downloads": -1,
"filename": "czekitout-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "14b1c2bc48c10cbef834402967848737",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 51974,
"upload_time": "2025-10-24T21:48:35",
"upload_time_iso_8601": "2025-10-24T21:48:35.698455Z",
"url": "https://files.pythonhosted.org/packages/32/7e/58947d602d049f3845c6785669e8fbe62373c6e62664ac4af7e982cd6a8a/czekitout-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 21:48:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mrfitzpa",
"github_project": "czekitout",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "czekitout"
}
