Metadata-Version: 2.4
Name: plimai
Version: 0.1.1
Summary: Plim is a platform for building and deploying AI agents.
Project-URL: Homepage, https://github.com/plim-ai/plim
Project-URL: Bug Tracker, https://github.com/plim-ai/plim/issues
Author-email: Plim <priteshraj41@gmail.com>
License: MIT License
        
        Copyright (c) 2024 [Your Name]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE. 
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# PlimAI

A Python package for building and deploying AI agents. PlimAI is designed to streamline the creation, testing, and deployment of intelligent agents, providing tools and frameworks for various AI tasks.

## Badges

![PyPI - Version](https://img.shields.io/pypi/v/plimai)
![PyPI - Downloads](https://img.shields.io/pypi/dm/plimai)
![Build Status](https://github.com/plimai/plim/workflows/Publish%20Python%20Package/badge.svg)
![Code Coverage](https://img.shields.io/codecov/c/github/plimai/plim)

## Installation

You can install the package using pip:

```bash
pip install plimai
```

## Usage

```python
from plimai import example
from plimai.example import get_version

# Example usage of hello function
print(example.hello("PlimAI User"))

# Example usage of get_version function
print(f"PlimAI Version: {get_version()}")
```

## Development

### Setup

1. Clone the repository:
   ```bash
   git clone https://github.com/plim-ai/plim.git
   cd plim
   ```

2. Install development dependencies:
   ```bash
   pip install -e ".[dev]"
   ```

### Version Control

This project uses semantic versioning and automatic version bumping:

- `feat:` commits trigger a minor version bump
- `fix:` commits trigger a patch version bump
- `feat!:` or `BREAKING CHANGE:` commits trigger a major version bump

### CI/CD

The project uses GitHub Actions for continuous integration and deployment:

1. On every push to main:
   - Version is automatically bumped based on commit messages
   - Package is built and published to PyPI
   - GitHub release is created

2. To trigger a new release:
   - Make your changes
   - Commit with a semantic commit message (e.g., `feat: add new feature`)
   - Push to main

## License

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