<!-- <p align="center">
<img src="ColabKit.jpg" alt="ColabKit logo" width="250" height="250">
</p> -->
# ColabKit
ColabKit is a Python library designed to enhance the experience of working in Google Colab environments. With ColabKit, you can simplify common tasks, manipulate media, record audio, and create interactive widgets more efficiently.
## Installation
You can easily install ColabKit using `pip`. Open a terminal and run:
```bash
pip install ColabKit
```
## Test in google colab
You can see the tests carried out on the library in Google Colab through this link
<a href="https://colab.research.google.com/github/wipodev/ColabKit/blob/main/Tests_ColabKit.ipynb" target="_blank"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
## Key Features
- **Media Manipulation**: Visualize and edit video and audio files directly in your notebook.
- **Audio Recording**: Record real-time audio through your browser with a simple function.
- **Interactive Widgets**: Create interactive buttons in the notebook to execute custom code.
- **System Utilities**: Simplify common tasks, such as file deletion and file existence checks.
## Usage Examples
### Video Display
```python
from ColabKit.media import showMedia
# Display a video file
showMedia('video.mp4', 'video')
```
### Audio Recording
```python
from ColabKit.record import record
# Record audio and save the result to a WAV file
record('recording.wav')
```
### Creating Interactive Buttons
```python
from ColabKit.widget import button
# Create an interactive button
def my_function():
print("You clicked the button!")
button("Click Me", "Click to execute my_function", "success", my_function)
```
## Documentation
For more information and detailed documentation, visit [the ColabKit repository on GitHub](https://github.com/wipodev/ColabKit).
## Contributions
We appreciate contributions! If you wish to contribute or report issues, visit [our GitHub repository](https://github.com/wipodev/ColabKit).
## License
This project is under the MIT License. See the [LICENSE](https://github.com/wipodev/ColabKit/blob/main/LICENSE) file for more details.
---
Raw data
{
"_id": null,
"home_page": "https://github.com/wipodev/ColabKit",
"name": "ColabKit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "google colaboratory ColabKit wipo wipodev functions Audio Recording Widgets Media Video Colab Python Tools",
"author": "Wipodev",
"author_email": "ajwipo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/21/bc/b942a7abafd63fbb5f4348752cc760d04989fdf0e0e9510e6f0338334b9b/ColabKit-0.0.1.tar.gz",
"platform": null,
"description": "<!-- <p align=\"center\">\r\n <img src=\"ColabKit.jpg\" alt=\"ColabKit logo\" width=\"250\" height=\"250\">\r\n</p> -->\r\n\r\n# ColabKit\r\n\r\nColabKit is a Python library designed to enhance the experience of working in Google Colab environments. With ColabKit, you can simplify common tasks, manipulate media, record audio, and create interactive widgets more efficiently.\r\n\r\n## Installation\r\n\r\nYou can easily install ColabKit using `pip`. Open a terminal and run:\r\n\r\n```bash\r\npip install ColabKit\r\n```\r\n\r\n## Test in google colab\r\n\r\nYou can see the tests carried out on the library in Google Colab through this link\r\n\r\n<a href=\"https://colab.research.google.com/github/wipodev/ColabKit/blob/main/Tests_ColabKit.ipynb\" target=\"_blank\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\r\n\r\n## Key Features\r\n\r\n- **Media Manipulation**: Visualize and edit video and audio files directly in your notebook.\r\n- **Audio Recording**: Record real-time audio through your browser with a simple function.\r\n- **Interactive Widgets**: Create interactive buttons in the notebook to execute custom code.\r\n- **System Utilities**: Simplify common tasks, such as file deletion and file existence checks.\r\n\r\n## Usage Examples\r\n\r\n### Video Display\r\n\r\n```python\r\nfrom ColabKit.media import showMedia\r\n\r\n# Display a video file\r\nshowMedia('video.mp4', 'video')\r\n```\r\n\r\n### Audio Recording\r\n\r\n```python\r\nfrom ColabKit.record import record\r\n\r\n# Record audio and save the result to a WAV file\r\nrecord('recording.wav')\r\n```\r\n\r\n### Creating Interactive Buttons\r\n\r\n```python\r\nfrom ColabKit.widget import button\r\n\r\n# Create an interactive button\r\ndef my_function():\r\n print(\"You clicked the button!\")\r\n\r\nbutton(\"Click Me\", \"Click to execute my_function\", \"success\", my_function)\r\n```\r\n\r\n## Documentation\r\n\r\nFor more information and detailed documentation, visit [the ColabKit repository on GitHub](https://github.com/wipodev/ColabKit).\r\n\r\n## Contributions\r\n\r\nWe appreciate contributions! If you wish to contribute or report issues, visit [our GitHub repository](https://github.com/wipodev/ColabKit).\r\n\r\n## License\r\n\r\nThis project is under the MIT License. See the [LICENSE](https://github.com/wipodev/ColabKit/blob/main/LICENSE) file for more details.\r\n\r\n---\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ColabKit: A Python library with essential tools to streamline your work in Google Colab, including functions for managing media, recording audio, generating interactive widgets, and performing common operations in the Colab environment.",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/wipodev/ColabKit/issues",
"Documentation": "https://github.com/wipodev/ColabKit/blob/main/README.md",
"Homepage": "https://github.com/wipodev/ColabKit",
"Source": "https://github.com/wipodev/ColabKit"
},
"split_keywords": [
"google",
"colaboratory",
"colabkit",
"wipo",
"wipodev",
"functions",
"audio",
"recording",
"widgets",
"media",
"video",
"colab",
"python",
"tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4130ca73c2aa85841453b05f50c048a8c59db2f5b5d244d32954e80f0c1b2679",
"md5": "ca31b7e78380794bfa576b9230df4059",
"sha256": "532a54d568e4f4ca0938c9a87fc9e3ddaf88bb2d491e6291acd149e5291782c6"
},
"downloads": -1,
"filename": "ColabKit-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca31b7e78380794bfa576b9230df4059",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7533,
"upload_time": "2023-10-21T14:08:49",
"upload_time_iso_8601": "2023-10-21T14:08:49.153535Z",
"url": "https://files.pythonhosted.org/packages/41/30/ca73c2aa85841453b05f50c048a8c59db2f5b5d244d32954e80f0c1b2679/ColabKit-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21bcb942a7abafd63fbb5f4348752cc760d04989fdf0e0e9510e6f0338334b9b",
"md5": "e2112e983959ac4c858d2cfc8bbe7a9e",
"sha256": "59c189075a80c4d404d88d7617e7857a0cc478f51baac1ffba369615fe3fb025"
},
"downloads": -1,
"filename": "ColabKit-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e2112e983959ac4c858d2cfc8bbe7a9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7561,
"upload_time": "2023-10-21T14:08:50",
"upload_time_iso_8601": "2023-10-21T14:08:50.984680Z",
"url": "https://files.pythonhosted.org/packages/21/bc/b942a7abafd63fbb5f4348752cc760d04989fdf0e0e9510e6f0338334b9b/ColabKit-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 14:08:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wipodev",
"github_project": "ColabKit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "colabkit"
}
JSON
