Installation

Ready to get Chunklet-py up and running? Fantastic! This guide will walk you through the installation process, making it as smooth as possible.

The Easy Way

The most straightforward method to install Chunklet-py is by using pip:

# Install and verify version
pip install chunklet-py
chunklet --version

And that's all there is to it! You're now ready to start using Chunklet-py.

Optional Dependencies

Chunklet-py offers optional dependencies to unlock additional functionalities, such as document processing or code chunking. You can install these extras using the following syntax:

Document Processing: For handling .pdf, .docx, .epub, and other document formats:
```
pip install "chunklet-py[document]"
```
Code Chunking: For advanced code analysis and chunking features:
```
pip install "chunklet-py[code]"
```
All Extras: To install all optional dependencies:
```
pip install "chunklet-py[document,code]"
```

The Alternative Way

For those who prefer to build from source, you can clone the repository and install it manually:

git clone https://github.com/speedyk-005/chunklet-py.git
cd chunklet-py
pip install .

But why would you want to do that? The easy way is so much easier.

Contributing to Chunklet-py

Interested in helping make Chunklet-py even better? That's fantastic! Before you dive in, please take a moment to review our Contributing Guide. Here's how you can set up your development environment:

git clone https://github.com/speedyk-005/chunklet-py.git
cd chunklet-py
pip install -e ".[dev]"

This command installs Chunklet-py in "editable" mode, ensuring that any changes you make to the source code are immediately reflected. The [dev] option includes all the necessary dependencies for running tests and building the documentation.

Now, go forth and code! And remember, good developers always write tests. (Even in a Python project, we appreciate all forms of excellent code examples!)