rediscache 1.0.0__tar.gz → 1.0.1__tar.gz

{rediscache-1.0.0 → rediscache-1.0.1}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: rediscache
-Version: 1.0.0
+Version: 1.0.1
 Summary: Redis caching of functions evolving over time
-Home-page: https://github.com/AmadeusITGroup/RedisCache
 License: MIT
 Keywords: redis,performance,cache
 Author: Pierre Cart-Grandjean
@@ -20,9 +19,10 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: executiontime (>=0.3.6,<0.4.0)
-Requires-Dist: redis (>=5.0.1,<6.0.0)
+Requires-Dist: executiontime (>=0.4.3,<0.5.0)
+Requires-Dist: redis (>=5.2.1,<6.0.0)
 Project-URL: Repository, https://github.com/AmadeusITGroup/RedisCache
 Description-Content-Type: text/markdown
 
@@ -46,7 +46,7 @@ This is a great caching mechanism for functions that will give a consistent outp
 
 ## Installation
 
-Simply install the PyPi package:
+Simply install the PyPi package [rediscache](https://pypi.org/project/rediscache/):
 
 ```bash
 pip install rediscache
@@ -188,10 +188,10 @@ My development environment is handled by Poetry. I use `Python 3.11.7`.
 
 To make sure we use Redis properly, we do not mock it in the unit tess. So you will need a localhost default instance of Redis server without a password. This means that the unit tests are more like integration tests.
 
-The execution of the tests including coverage result can be done with `test.sh`. You can also run just `pytest`:
+The execution of the tests including coverage result is done with `pytest`:
 
 ```bash
-./test.sh
+poetry run pytest --cov=rediscache
 ```
 
 ## CI/CD
@@ -210,3 +210,21 @@ We get help from re-usable actions. Here is the [Marketplace](https://github.com
 
 For the moment the publish to PyPI is done manually with the `publish.sh` script. You will need a PyPI API token in `PYPI_API_TOKEN`, stored in a `secrets.sh`.
 
+## Demo application
+
+In the `demo` directory you will find a web application to test `RedisCache`.
+
+```bash
+poetry run webapp
+```
+
+Entry points:
+
+- Call to long function with parameter value `20` and using the cache but waiting for a result: [link](http://localhost:9090/cached/20)
+- Call to long function with parameter value `20` without using the cache: [link](http://localhost:9090/direct/20)
+- Get the stats stored in Redis database: [link](http://localhost:9090/stats)
+
+There is also a `Nginx` configuration file to further test if with a load balancing of workers. It is useful to demonstrate that many workers can share efficiently the same instance of `Redis`.
+
+Finally a `Gatling` configuration file can be used to test the performance.
+

{rediscache-1.0.0 → rediscache-1.0.1}/README.md

@@ -18,7 +18,7 @@ This is a great caching mechanism for functions that will give a consistent outp
 
 ## Installation
 
-Simply install the PyPi package:
+Simply install the PyPi package [rediscache](https://pypi.org/project/rediscache/):
 
 ```bash
 pip install rediscache
@@ -160,10 +160,10 @@ My development environment is handled by Poetry. I use `Python 3.11.7`.
 
 To make sure we use Redis properly, we do not mock it in the unit tess. So you will need a localhost default instance of Redis server without a password. This means that the unit tests are more like integration tests.
 
-The execution of the tests including coverage result can be done with `test.sh`. You can also run just `pytest`:
+The execution of the tests including coverage result is done with `pytest`:
 
 ```bash
-./test.sh
+poetry run pytest --cov=rediscache
 ```
 
 ## CI/CD
@@ -181,3 +181,21 @@ We get help from re-usable actions. Here is the [Marketplace](https://github.com
 ### Publish to PyPI
 
 For the moment the publish to PyPI is done manually with the `publish.sh` script. You will need a PyPI API token in `PYPI_API_TOKEN`, stored in a `secrets.sh`.
+
+## Demo application
+
+In the `demo` directory you will find a web application to test `RedisCache`.
+
+```bash
+poetry run webapp
+```
+
+Entry points:
+
+- Call to long function with parameter value `20` and using the cache but waiting for a result: [link](http://localhost:9090/cached/20)
+- Call to long function with parameter value `20` without using the cache: [link](http://localhost:9090/direct/20)
+- Get the stats stored in Redis database: [link](http://localhost:9090/stats)
+
+There is also a `Nginx` configuration file to further test if with a load balancing of workers. It is useful to demonstrate that many workers can share efficiently the same instance of `Redis`.
+
+Finally a `Gatling` configuration file can be used to test the performance.

{rediscache-1.0.0 → rediscache-1.0.1}/pyproject.toml

@@ -1,6 +1,7 @@
+# For more details on this file see: https://python-poetry.org/docs/pyproject/
 [tool.poetry]
 name = "rediscache"
-version = "1.0.0"
+version = "1.0.1"
 description = "Redis caching of functions evolving over time"
 authors = ["Pierre Cart-Grandjean <pcart-grandjean@amadeus.com>"]
 license = "MIT"
@@ -21,25 +22,31 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
+packages = [{ include = "rediscache" }]
 
 [tool.poetry.dependencies]
 python = "^3.9"
-redis = "^5.0.1"
-executiontime = "^0.3.6"
+redis = "^5.2.1"
+executiontime = "^0.4.3"
 
 [tool.poetry.group.dev.dependencies]
-pylint = "^3.0.3"
-pytest = "^8.0.1"
+pylint = "^3.3.5"
+pytest = "^8.3.5"
 pdbpp = "^0.10.3"
-coverage = "^7.4.2"
-mypy = "^1.8.0"
-safety = "^3.0.1"
-black = "^24.2.0"
+mypy = "^1.15.0"
+safety = "^3.3.1"
+black = "^25.1.0"
+pytest-cov = "^6.0.0"
+tornado = "^6.4.2"
+pip-audit = "^2.8.0"
 
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.poetry.scripts]
+webapp = "demo.webapp:main"
+
 [tool.mypy]
 strict = true
 

{rediscache-1.0.0 → rediscache-1.0.1}/rediscache/__init__.py

@@ -35,7 +35,6 @@ TODO:
 """
 
 from functools import wraps
-from json import dumps, loads
 import logging
 import os
 import threading