Skip to content

Commit c4381d4

Browse files
committed
update README and CHANGELOG
Signed-off-by: Grant Ramsay <seapagan@gmail.com>
1 parent 7397739 commit c4381d4

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed

CHANGELOG.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,20 @@ project since the first release, with the latest changes at the top.
66
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88

9-
## [Unreleased](https://github.com/seapagan/fastapi-redis-cache-reborn/tree/HEAD)
9+
## [0.3.0](https://github.com/seapagan/fastapi-redis-cache-reborn/releases/tag/0.3.0) (June 04, 2024)
1010

11+
**_'It's Alive!!!!'_**
1112

12-
These are the changes that have been merged to the repository since the last
13-
release. If you want to try out these changes, you can install the latest
14-
version from the main branch by running:
1513

16-
```console
17-
$ pip install git+https://github.com/seapagan/fastapi-redis-cache-reborn
18-
```
19-
20-
or, if using poetry:
21-
22-
```console
23-
$ poetry add git+https://github.com/seapagan/fastapi-redis-cache-reborn
24-
```
25-
Everything in this section will be included in the next official release.
14+
This is the first release of the project since the fork from the original. It
15+
includes some changes and fixes but otherise is the same functionality as the
16+
original, though with modernized dependencies and tooling.
2617

2718

2819
**New Features**
2920

21+
- Update docker file to use `redis/redis-stack` ([#20](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/20)) by [seapagan](https://github.com/seapagan)
22+
- Add a 'tag' parameter to the 'cache' decorator for future functionality ([#16](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/16)) by [seapagan](https://github.com/seapagan)
3023
- Run mypy as a GitHub Action ([#10](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/10)) by [seapagan](https://github.com/seapagan)
3124
- Support more object types ([#9](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/9)) by [seapagan](https://github.com/seapagan)
3225

@@ -41,12 +34,23 @@ Everything in this section will be included in the next official release.
4134

4235
**Documentation**
4336

37+
- Add a changelog generator to the project ([#13](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/13)) by [seapagan](https://github.com/seapagan)
4438
- Add Python 'Trove' classifiers to the project ([#12](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/12)) by [seapagan](https://github.com/seapagan)
4539
- Rename project and update README ([#11](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/11)) by [seapagan](https://github.com/seapagan)
4640

4741
**Dependency Updates**
4842

49-
- Bump pymarkdownlnt from 0.9.17 to 0.9.18 ([#6](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/6)) by [dependabot[bot]](https://github.com/apps/dependabot)
43+
- Bump requests from 2.31.0 to 2.32.2 ([#82](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/82)) by [dependabot[bot]](https://github.com/apps/dependabot)
44+
- Bump jinja2 from 3.1.3 to 3.1.4 ([#81](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/81)) by [dependabot[bot]](https://github.com/apps/dependabot)
45+
- Bump faker from 24.14.0 to 25.4.0 ([#80](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/80)) by [dependabot[bot]](https://github.com/apps/dependabot)
46+
- Bump ruff from 0.4.2 to 0.4.7 ([#79](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/79)) by [dependabot[bot]](https://github.com/apps/dependabot)
47+
- Bump pymarkdownlnt from 0.9.18 to 0.9.20 ([#78](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/78)) by [dependabot[bot]](https://github.com/apps/dependabot)
48+
- Bump pytest from 8.1.2 to 8.2.1 ([#73](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/73)) by [dependabot[bot]](https://github.com/apps/dependabot)
49+
- Bump fakeredis from 2.22.0 to 2.23.2 ([#72](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/72)) by [dependabot[bot]](https://github.com/apps/dependabot)
50+
- Bump pre-commit from 3.7.0 to 3.7.1 ([#70](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/70)) by [dependabot[bot]](https://github.com/apps/dependabot)
51+
- Bump pyfakefs from 5.4.1 to 5.5.0 ([#69](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/69)) by [dependabot[bot]](https://github.com/apps/dependabot)
52+
- Bump jinja2 from 3.1.3 to 3.1.4 ([#63](https://github.com/seapagan/fastapi-redis-cache-reborn/pull/63)) by [dependabot[bot]](https://github.com/apps/dependabot)
53+
- *and 35 more dependency updates*
5054

5155
---
5256
*This changelog was generated using [github-changelog-md](http://changelog.seapagan.net/) by [Seapagan](https://github.com/seapagan)*

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# fastapi-redis-cache-reborn <!-- omit in toc -->
22

3-
<!-- [![PyPI version](https://badge.fury.io/py/fastapi-redis-cache-reborn.svg)](https://badge.fury.io/py/fastapi-redis-cache-reborn)
4-
![PyPI - Downloads](https://img.shields.io/pypi/dm/fastapi-redis-cache?color=%234DC71F)
5-
![PyPI - License](https://img.shields.io/pypi/l/fastapi-redis-cache?color=%25234DC71F)
6-
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fastapi-redis-cache)
7-
-->
3+
![PyPI - Version](https://img.shields.io/pypi/v/fastapi-redis-cache-reborn)
4+
![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/fastapi-redis-cache-reborn)
5+
[![Tests](https://github.com/seapagan/fastapi-redis-cache-reborn/actions/workflows/tests.yml/badge.svg)](https://github.com/seapagan/fastapi-redis-cache-reborn/actions/workflows/tests.yml)
6+
[![Linting](https://github.com/seapagan/fastapi-redis-cache-reborn/actions/workflows/ruff.yml/badge.svg)](https://github.com/seapagan/fastapi-redis-cache-reborn/actions/workflows/ruff.yml)
7+
[![Type Checking](https://github.com/seapagan/fastapi-redis-cache-reborn/actions/workflows/mypy.yml/badge.svg)](https://github.com/seapagan/fastapi-redis-cache-reborn/actions/workflows/mypy.yml)
8+
![PyPI - License](https://img.shields.io/pypi/l/fastapi-redis-cache-reborn?color=%25234DC71F)
9+
![PyPI - Downloads](https://img.shields.io/pypi/dm/fastapi-redis-cache-reborn?color=%234DC71F)
810

911
- [Migrating from `fastapi-redis-cache`](#migrating-from-fastapi-redis-cache)
1012
- [Features](#features)

0 commit comments

Comments
 (0)