# Changelog

All notable changes to the S3verless project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.1.0] - 2025-01-XX - Initial Alpha Release

### 🎉 First Release

S3verless is a Python framework for building web applications using Amazon S3 as a backend.

### Core Features

- **S3 as a Database**: Store and query data as JSON objects in S3
- **FastAPI Integration**: Auto-generated REST APIs for your models
- **Admin Interface**: Built-in admin panel for data management
- **Query System**: Filter, sort, paginate, and search S3 data
- **Authentication**: JWT-based auth with users stored in S3
- **Model System**: Pydantic-based models with automatic serialization
- **CLI Tool**: Command-line utilities for project management

### Examples

- Todo app example
- Blog platform example
- E-commerce catalog example
- Authentication example

### Documentation

- README with quick start guide
- API examples and usage patterns
- Contributing guidelines
- MIT License

### Technical Details

- Python 3.9+ support
- 94 passing tests with 69% code coverage
- Modern type hints (PEP 604, PEP 585)
- Async/await throughout
- Compatible with AWS S3 and LocalStack

---

## Future Roadmap

See the [Future Work section in the README](README.md#-future-work--roadmap) for planned features and improvements.

---

## Contributing

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

## License

S3verless is released under the [MIT License](LICENSE).

