opencopilot-utils 1.0.10

Utility function for getting embeddings, llms, chat completion models etc

Project Description

In your README.md file, you can provide a detailed project description. Based on your provided description, it would look like this:

# OpenCopilot Utility Library

The OpenCopilot Utility Library contains a collection of common utility functions, types, and interfaces used across the entire OpenCopilot application. It also provides essential embeddings for your project.

## Features

- A comprehensive set of utility functions.
- Common types and interfaces that are widely used within the application.
- Pre-configured embeddings for seamless integration.

## Getting Started

To start using the utility library, you can initialize your vector store with the provided embeddings using the following code:

```python
from opencopilot_utils import get_embeddings, init_vector_store, StoreOptions

embeddings = get_embeddings()
init_vector_store(docs, embeddings, StoreOptions(namespace=bot_id))

Installation

You can install the library via pip:

pip install opencopilot-utils

Usage

To use the utility functions and types, simply import them in your Python code:

from opencopilot_utils import some_utility_function, SomeCommonType

For more details and examples, please refer to the official documentation.

Contributing

We welcome contributions from the community. If you have suggestions, bug reports, or would like to contribute to the project, please check our contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

## Publishing Your Library

You've provided the steps for publishing your library, which are correct. Here's the complete guide for publishing:

1. Create distribution packages:

   ```bash
   python setup.py sdist bdist_wheel

2. Install twine, a tool for securely uploading your distribution packages:

   pip install twine
   

3. Upload your distribution packages to PyPI using twine. Replace dist/* with the actual paths to your distribution packages:

   twine upload dist/*
   

4. You'll be prompted to enter your PyPI username and password or your API token. Follow the prompts to complete the upload.

Your library will then be published on PyPI and accessible to the Python community.

Ensure that you've included a README.md file with a project description, and that your setup.py includes the necessary metadata, as shown in the previous responses.

remove dist rm -rf build dist opencopilot_utils.egg-info