semvec/pypi-packages huggingface dataset:
pynenc-mongo 0.1.4
MongoDB plugging for pynenc, a distributed task queue for Python.
License: MIT License
Requires Python: <4.0,>=3.11.6

# Pynenc MongoDB Plugin

[![CI](https://github.com/pynenc/pynenc-mongodb/actions/workflows/ci.yml/badge.svg)](https://github.com/pynenc/pynenc-mongodb/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/pynenc/pynenc-mongodb/branch/main/graph/badge.svg)](https://codecov.io/gh/pynenc/pynenc-mongodb)
[![PyPI version](https://badge.fury.io/py/pynenc-mongodb.svg)](https://badge.fury.io/py/pynenc-mongodb)
[![Python versions](https://img.shields.io/pypi/pyversions/pynenc-mongodb.svg)](https://pypi.org/project/pynenc-mongodb/)

MongoDB state backend plugin for [Pynenc](https://github.com/pynenc/pynenc), providing distributed task state management using MongoDB as the storage backend.

## Features

- 🚀 **High Performance**: Optimized MongoDB operations with connection pooling
- 🔒 **Distributed Locking**: MongoDB-based distributed locks for task coordination
- 🎯 **Type Safe**: Full type hints and mypy compatibility
- 🧪 **Well Tested**: Comprehensive test suite with multiple MongoDB versions
- 📊 **Production Ready**: Battle-tested configuration options and monitoring

## Quick Start

### Installation

```bash
pip install pynenc-mongodb
```

### Basic Usage

```python
from pynenc import Pynenc
from pynenc_mongodb import MongoStateBackend

# Create Pynenc app with MongoDB backend
app = Pynenc().with_state_backend(
    MongoStateBackend.from_uri("mongodb://localhost:27017/pynenc")
)

@app.task
def my_task(x: int, y: int) -> int:
    return x + y

# Use your tasks as normal
result = my_task(1, 2)
```

## Configuration

### Connection Configuration

```python
from pynenc_mongodb import MongoStateBackend, ConfigMongoDB

config = ConfigMongoDB(
    uri="mongodb://localhost:27017",
    database_name="my_pynenc_db",
    max_pool_size=100,
    write_concern_w="majority",
    read_preference="primaryPreferred"
)

backend = MongoStateBackend(config)
```

### Environment Variables

You can also configure via environment variables:

```bash
export PYNENC_MONGODB_URI="mongodb://localhost:27017"
export PYNENC_MONGODB_DATABASE="pynenc"
export PYNENC_MONGODB_MAX_POOL_SIZE="100"
```

## Documentation

- [Configuration Guide](docs/configuration/index.md)
- [Usage Examples](docs/usage/index.md)
- [Migration Guide](docs/migration/index.md)

## Development

### Setup

1. Clone the repository
2. Install dependencies: `poetry install --with dev`
3. Start MongoDB: `docker-compose -f docker/docker-compose.yml up -d`
4. Run tests: `poetry run pytest`

### Contributing

We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## License

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