Metadata-Version: 2.1
Name: ColabKit
Version: 0.0.1
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.
Home-page: https://github.com/wipodev/ColabKit
Author: Wipodev
Author-email: ajwipo@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/wipodev/ColabKit/blob/main/README.md
Project-URL: Source, https://github.com/wipodev/ColabKit
Project-URL: Bug Tracker, https://github.com/wipodev/ColabKit/issues
Keywords: google colaboratory ColabKit wipo wipodev functions Audio Recording Widgets Media Video Colab Python Tools
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

<!-- <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.

---
