# IO-Components
IO-Components is a Python package that contains handy functions.
It's main goal, however, is to demonstrate how to create
a package and demonstrate how to upload it to PyPi.
Check out [this](https://mikehuls.medium.com/create-your-custom-python-package-that-you-can-pip-install-from-your-git-repository-f90465867893)
article for a detailed explanation on how to create your
custom Python package and upload it to PyPi!
## Installation and updating
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Toolbox like below.
Rerun this command to check for and install updates .
```bash
pip install git+https://github.com/Muls/toolbox
```
## Usage
Features:
* functions.listChunker --> generator that chunks and interable in evenly sized chunks
* functions.weirdCase --> converts a string to a totally unreadable format
* functions.report --> prints to the console with a timestamp
* decorators.singleton --> used for decoratint your class to make it a singleton
#### Demo of some of the features:
```python
import mikes_toolbox
from mikes_toolbox import report
message = mikes_toolbox.functions.weirdCase("The mikes_toolbox package is ready for use")
report(message)
list_of_numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
for chunk in mikes_toolbox.functions.listChunker(lst=list_of_numbers, dsize=3):
print(chunk)
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/eatcala/io-components",
"name": "io-components",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pypi,io-components",
"author": "Nicolas Pichon",
"author_email": "pichon.nicolas1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/77/6a/f52388dcd4ca7318dbe2716fa9337c3ef375a1785b5fe368535389a62c49/io-components-0.0.1.tar.gz",
"platform": null,
"description": "# IO-Components\n\nIO-Components is a Python package that contains handy functions. \nIt's main goal, however, is to demonstrate how to create \na package and demonstrate how to upload it to PyPi. \nCheck out [this](https://mikehuls.medium.com/create-your-custom-python-package-that-you-can-pip-install-from-your-git-repository-f90465867893)\narticle for a detailed explanation on how to create your \ncustom Python package and upload it to PyPi!\n\n## Installation and updating\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install Toolbox like below. \nRerun this command to check for and install updates .\n```bash\npip install git+https://github.com/Muls/toolbox\n```\n\n## Usage\nFeatures:\n* functions.listChunker --> generator that chunks and interable in evenly sized chunks \n* functions.weirdCase --> converts a string to a totally unreadable format\n* functions.report --> prints to the console with a timestamp\n* decorators.singleton --> used for decoratint your class to make it a singleton\n\n#### Demo of some of the features:\n\n```python\nimport mikes_toolbox\nfrom mikes_toolbox import report\n\nmessage = mikes_toolbox.functions.weirdCase(\"The mikes_toolbox package is ready for use\")\nreport(message)\n\nlist_of_numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]\nfor chunk in mikes_toolbox.functions.listChunker(lst=list_of_numbers, dsize=3):\n print(chunk)\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Testing installation of Package",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/eatcala/io-components/issues",
"Download": "https://github.com/eatcala/io-components/archive/refs/tags/0.0.1.tar.gz",
"Homepage": "https://github.com/eatcala/io-components"
},
"split_keywords": [
"pypi",
"io-components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "776af52388dcd4ca7318dbe2716fa9337c3ef375a1785b5fe368535389a62c49",
"md5": "892caccd52d2a859d59f128f5b287146",
"sha256": "f15a78bf1de32fae1ff61e916fee98aeb7563f24aebbf24cb16bfb0b3d216aa1"
},
"downloads": -1,
"filename": "io-components-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "892caccd52d2a859d59f128f5b287146",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12225,
"upload_time": "2023-08-14T14:35:55",
"upload_time_iso_8601": "2023-08-14T14:35:55.457651Z",
"url": "https://files.pythonhosted.org/packages/77/6a/f52388dcd4ca7318dbe2716fa9337c3ef375a1785b5fe368535389a62c49/io-components-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-14 14:35:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eatcala",
"github_project": "io-components",
"github_not_found": true,
"lcname": "io-components"
}
JSON
