forked from Shifty/pyserveX
537b783726
- Create a GitHub Actions workflow for testing with Python 3.12 and 3.13. - Update Makefile to include release management commands and pipeline checks. - Document the CI/CD pipeline structure and usage in PIPELINE.md. - Add structlog for structured logging and enhance logging utilities. - Implement release management script for automated versioning and tagging. - Modify logging configuration to support structured logging and improved formatting. - Update dependencies in pyproject.toml and poetry.lock to include structlog. - Enhance access logging in server and middleware to include structured data.
66 lines
1.3 KiB
Markdown
66 lines
1.3 KiB
Markdown
# PyServeX v{VERSION}
|
|
|
|
## What's new in this version
|
|
|
|
### New Features
|
|
- [ ] Add description of new features
|
|
- [ ] List new commands or options
|
|
- [ ] Mention performance improvements
|
|
|
|
### Bug Fixes
|
|
- [ ] Describe fixed bugs
|
|
- [ ] Mention resolved security issues
|
|
- [ ] List compatibility fixes
|
|
|
|
### Technical Changes
|
|
- [ ] Dependency updates
|
|
- [ ] Code refactoring
|
|
- [ ] Architecture improvements
|
|
|
|
### Documentation
|
|
- [ ] README updates
|
|
- [ ] New usage examples
|
|
- [ ] API changes
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install pyserve=={VERSION}
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# Basic usage
|
|
pyserve
|
|
|
|
# With custom configuration
|
|
pyserve --config config.yaml
|
|
|
|
# In debug mode
|
|
pyserve --debug
|
|
```
|
|
|
|
## Migration from previous version
|
|
|
|
If you're upgrading from version v{PREVIOUS_VERSION}:
|
|
|
|
1. [ ] Describe necessary configuration changes
|
|
2. [ ] Mention deprecated functions
|
|
3. [ ] Provide migration examples
|
|
|
|
## Known Issues
|
|
|
|
- [ ] List known limitations
|
|
- [ ] Provide workarounds for issues
|
|
- [ ] Link to relevant issues
|
|
|
|
## Acknowledgments
|
|
|
|
Thanks to all contributors who made this version possible!
|
|
|
|
---
|
|
|
|
**Full changelog:** https://git.pyserve.org/Shifty/pyserveX/compare/v{PREVIOUS_VERSION}...v{VERSION}
|
|
**Documentation:** https://git.pyserve.org/Shifty/pyserveX/wiki
|
|
**Report a bug:** https://git.pyserve.org/Shifty/pyserveX/issues/new |