# DeepRanker

[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

DeepRanker is a lightweight Python library that provides basic arithmetic operations. It's designed to be simple, efficient, and easy to integrate into your projects.

## Features

- ✨ Simple and intuitive API
- 🔢 Basic arithmetic operations (add, subtract, multiply, divide)
- 🛡️ Type hints for better code clarity
- ✅ Comprehensive error handling
- 🧪 Full test coverage

## Installation

Install FeatureRank from PyPI:

```bash
pip install deepranker
```

Or install from source:

```bash
git clone https://github.com/yourusername/deepranker.git
cd deepranker
pip install -e .
```

## Quick Start

```python
from FeatureRank import add, subtract, multiply, divide

print(add(10, 5))        # 15
print(subtract(10, 5))   # 5
print(multiply(10, 5))   # 50
print(divide(10, 5))     # 2.0
```

## Available Functions

| Function | Description |
|----------|-------------|
| `add(a, b)` | Returns the sum of two numbers |
| `subtract(a, b)` | Returns the difference of two numbers |
| `multiply(a, b)` | Returns the product of two numbers |
| `divide(a, b)` | Returns the quotient of two numbers |

For detailed API documentation, see [docs/API.md](docs/API.md).

## Documentation

- 📖 [API Reference](docs/API.md) - Complete function documentation
- 🛠️ [Development Guide](docs/DEVELOPMENT.md) - Setup and contribution instructions
- 🤝 [Contributing Guide](docs/CONTRIBUTING.md) - How to contribute
- 📝 [Changelog](CHANGELOG.md) - Project history and version information

## Development

To set up a development environment:

```bash
# Clone the repository
git clone https://github.com/yourusername/deepranker.git
cd deepranker

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode with dependencies
pip install -e ".[dev]"

# Run tests
pytest
```

See [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) for more details.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Please see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for guidelines.

