Skip to content

A high-performance object storage service built with FastAPI, designed for reliability, scalability, and ease of use.

License

Notifications You must be signed in to change notification settings

liliang8858/objsave

Repository files navigation

ObSave

Build Status Coverage Status PyPI version License: MIT Python Version

English | 简体中文

A high-performance object storage service built with FastAPI, designed for reliability, scalability, and ease of use.

Features

  • High Performance - Asynchronous processing with memory caching
  • Object Storage - Store and retrieve objects of any type
  • Smart Querying - Complex queries via JSONPath
  • Monitoring - Comprehensive system monitoring and metrics
  • Security - Built-in access control and encryption
  • Real-time Monitoring - System status monitoring and alerts

Installation

pip install obsave

For development installation:

git clone https://github.com/yourusername/obsave.git
cd obsave
pip install -e ".[dev]"

Quick Start

from obsave import ObjectStorage

# Initialize storage
storage = ObjectStorage()

# Store an object
storage.store("my_key", {"data": "value"})

# Retrieve an object
obj = storage.get("my_key")
print(obj)  # {"data": "value"}

For more examples, see the examples directory.

Documentation

Full documentation is available at https://obsave.readthedocs.io/.

Development

We use a number of tools to ensure code quality:

# Install development dependencies
make install

# Run tests
make test

# Format code
make format

# Run linters
make lint

# Build documentation
make docs

Project Structure

obsave/
├── src/
│   └── obsave/
│       ├── api/        # FastAPI routes and endpoints
│       ├── core/       # Core functionality
│       ├── storage/    # Storage backends
│       ├── monitoring/ # Monitoring and metrics
│       └── utils/      # Utility functions
├── tests/             # Test suite
├── docs/              # Documentation
├── examples/          # Example code
└── scripts/           # Utility scripts

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

License

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

For commercial use, please contact: [email protected]

Acknowledgments

Special thanks to all our contributors who have helped make ObSave better.

About

A high-performance object storage service built with FastAPI, designed for reliability, scalability, and ease of use.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published