invenio-cache 3.0.0__tar.gz → 3.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. invenio_cache-3.0.2/.gitignore +63 -0
  2. invenio_cache-3.0.2/AUTHORS.rst +8 -0
  3. invenio_cache-3.0.2/PKG-INFO +48 -0
  4. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/README.rst +2 -5
  5. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/__init__.py +7 -10
  6. invenio_cache-3.0.2/invenio_cache/_compat.py +12 -0
  7. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/bccache.py +2 -7
  8. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/config.py +5 -9
  9. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/decorators.py +2 -7
  10. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/errors.py +2 -6
  11. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/ext.py +3 -8
  12. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/lock.py +3 -7
  13. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/invenio_cache/proxies.py +2 -7
  14. invenio_cache-3.0.2/pyproject.toml +70 -0
  15. invenio_cache-3.0.0/.dockerignore +0 -15
  16. invenio_cache-3.0.0/.editorconfig +0 -32
  17. invenio_cache-3.0.0/.git-blame-ignore-revs +0 -1
  18. invenio_cache-3.0.0/AUTHORS.rst +0 -11
  19. invenio_cache-3.0.0/CHANGES.rst +0 -51
  20. invenio_cache-3.0.0/CONTRIBUTING.rst +0 -125
  21. invenio_cache-3.0.0/INSTALL.rst +0 -29
  22. invenio_cache-3.0.0/MANIFEST.in +0 -27
  23. invenio_cache-3.0.0/PKG-INFO +0 -105
  24. invenio_cache-3.0.0/invenio_cache/_compat.py +0 -17
  25. invenio_cache-3.0.0/invenio_cache.egg-info/PKG-INFO +0 -105
  26. invenio_cache-3.0.0/invenio_cache.egg-info/SOURCES.txt +0 -31
  27. invenio_cache-3.0.0/invenio_cache.egg-info/dependency_links.txt +0 -1
  28. invenio_cache-3.0.0/invenio_cache.egg-info/entry_points.txt +0 -5
  29. invenio_cache-3.0.0/invenio_cache.egg-info/not-zip-safe +0 -1
  30. invenio_cache-3.0.0/invenio_cache.egg-info/requires.txt +0 -11
  31. invenio_cache-3.0.0/invenio_cache.egg-info/top_level.txt +0 -1
  32. invenio_cache-3.0.0/pyproject.toml +0 -5
  33. invenio_cache-3.0.0/requirements-devel.txt +0 -10
  34. invenio_cache-3.0.0/run-tests.sh +0 -28
  35. invenio_cache-3.0.0/setup.cfg +0 -66
  36. invenio_cache-3.0.0/setup.py +0 -13
  37. {invenio_cache-3.0.0 → invenio_cache-3.0.2}/LICENSE +0 -0
@@ -0,0 +1,63 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+
5
+ # Idea software family
6
+ .idea/
7
+
8
+ # C extensions
9
+ *.so
10
+
11
+ # Distribution / packaging
12
+ .Python
13
+ env/
14
+ build/
15
+ develop-eggs/
16
+ dist/
17
+ downloads/
18
+ eggs/
19
+ .eggs/
20
+ lib/
21
+ lib64/
22
+ parts/
23
+ sdist/
24
+ var/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .coverage
43
+ .coverage.*
44
+ .cache
45
+ nosetests.xml
46
+ coverage.xml
47
+ *,cover
48
+
49
+ # Translations
50
+ *.mo
51
+
52
+ # Django stuff:
53
+ *.log
54
+
55
+ # Sphinx documentation
56
+ docs/_build/
57
+
58
+ # PyBuilder
59
+ target/
60
+
61
+ # Vim swapfiles
62
+ .*.sw?
63
+ uv.lock
@@ -0,0 +1,8 @@
1
+ ..
2
+ SPDX-FileCopyrightText: 2017-2018 CERN.
3
+ SPDX-License-Identifier: MIT
4
+
5
+ Contributors
6
+ ============
7
+
8
+ - Lars Holm Nielsen
@@ -0,0 +1,48 @@
1
+ Metadata-Version: 2.5
2
+ Name: invenio-cache
3
+ Version: 3.0.2
4
+ Summary: Cache module for Invenio.
5
+ Project-URL: Repository, https://github.com/inveniosoftware/invenio-cache
6
+ Author-email: CERN <info@inveniosoftware.org>
7
+ License-Expression: MIT
8
+ License-File: AUTHORS.rst
9
+ License-File: LICENSE
10
+ Keywords: cache,invenio
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Requires-Python: >=3.9
13
+ Requires-Dist: flask-caching>=1.8.0
14
+ Requires-Dist: invenio-base<3.0.0,>=2.0.0
15
+ Provides-Extra: tests
16
+ Requires-Dist: flask-login>=0.6.3; extra == 'tests'
17
+ Requires-Dist: mock>=2.0.0; extra == 'tests'
18
+ Requires-Dist: pytest-black>=0.6.0; extra == 'tests'
19
+ Requires-Dist: pytest-invenio<5.0.0,>=4.0.0; extra == 'tests'
20
+ Requires-Dist: pytest-mock>=1.6.0; extra == 'tests'
21
+ Requires-Dist: redis>=2.10.5; extra == 'tests'
22
+ Requires-Dist: sphinx>=3; extra == 'tests'
23
+ Description-Content-Type: text/x-rst
24
+
25
+ ..
26
+ SPDX-FileCopyrightText: 2017-2018 CERN.
27
+ SPDX-License-Identifier: MIT
28
+
29
+ ===============
30
+ Invenio-Cache
31
+ ===============
32
+
33
+ .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-cache.svg
34
+ :target: https://github.com/inveniosoftware/invenio-cache/blob/master/LICENSE
35
+
36
+ .. image:: https://github.com/inveniosoftware/invenio-cache/workflows/CI/badge.svg
37
+ :target: https://github.com/inveniosoftware/invenio-cache/actions?query=workflow%3ACI
38
+
39
+ .. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-cache.svg
40
+ :target: https://coveralls.io/r/inveniosoftware/invenio-cache
41
+
42
+ .. image:: https://img.shields.io/pypi/v/invenio-cache.svg
43
+ :target: https://pypi.org/pypi/invenio-cache
44
+
45
+ Cache module for Invenio.
46
+
47
+ Further documentation is available on
48
+ https://invenio-cache.readthedocs.io/
@@ -1,9 +1,6 @@
1
1
  ..
2
- This file is part of Invenio.
3
- Copyright (C) 2017-2018 CERN.
4
-
5
- Invenio is free software; you can redistribute it and/or modify it
6
- under the terms of the MIT License; see LICENSE file for more details.
2
+ SPDX-FileCopyrightText: 2017-2018 CERN.
3
+ SPDX-License-Identifier: MIT
7
4
 
8
5
  ===============
9
6
  Invenio-Cache
@@ -1,11 +1,8 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- # Copyright (C) 2024-2026 Graz University of Technology.
6
- #
7
- # Invenio is free software; you can redistribute it and/or modify it
8
- # under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-FileCopyrightText: 2024-2026 Graz University of Technology.
3
+ # SPDX-FileCopyrightText: 2026 TU Wien.
4
+ # SPDX-FileCopyrightText: 2026 KTH Royal Institute of Technology.
5
+ # SPDX-License-Identifier: MIT
9
6
 
10
7
  """Cache module for Invenio.
11
8
 
@@ -16,7 +13,7 @@ Create a Flask application:
16
13
 
17
14
  >>> from flask import Flask
18
15
  >>> app = Flask('myapp')
19
- >>> app.config['CACHE_TYPE'] = 'simple'
16
+ >>> app.config['CACHE_TYPE'] = 'SimpleCache'
20
17
 
21
18
  Initialize Invenio-Cache:
22
19
 
@@ -78,7 +75,7 @@ from .decorators import cached_unless_authenticated
78
75
  from .ext import InvenioCache
79
76
  from .proxies import current_cache, current_cache_ext
80
77
 
81
- __version__ = "3.0.0"
78
+ __version__ = "3.0.2"
82
79
 
83
80
  __all__ = (
84
81
  "__version__",
@@ -0,0 +1,12 @@
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-License-Identifier: MIT
3
+
4
+ """Python 2/3 compatibility module."""
5
+
6
+ from __future__ import absolute_import, print_function
7
+
8
+ import sys
9
+
10
+ PY3 = sys.version_info[0] == 3
11
+
12
+ string_types = str if PY3 else basestring
@@ -1,10 +1,5 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-License-Identifier: MIT
8
3
 
9
4
  """Jinja bytecode cache for Redis."""
10
5
 
@@ -1,11 +1,7 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- # Copyright (C) 2025 Graz University of Technology.
6
- #
7
- # Invenio is free software; you can redistribute it and/or modify it
8
- # under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-FileCopyrightText: 2025 Graz University of Technology.
3
+ # SPDX-FileCopyrightText: 2026 KTH Royal Institute of Technology.
4
+ # SPDX-License-Identifier: MIT
9
5
 
10
6
  """Configuration for Invenio-Cache module.
11
7
 
@@ -21,7 +17,7 @@ CACHE_KEY_PREFIX = "cache::"
21
17
  """Cache key prefix."""
22
18
 
23
19
  #: Sets the cache type.
24
- CACHE_TYPE = "flask_caching.backends.redis"
20
+ CACHE_TYPE = "flask_caching.backends.RedisCache"
25
21
  """Cache type.
26
22
 
27
23
  Please refer to Flask-Caching documentation for other cache types.
@@ -1,10 +1,5 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2023 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2017-2023 CERN.
2
+ # SPDX-License-Identifier: MIT
8
3
 
9
4
  """Decorators to help with caching."""
10
5
 
@@ -1,9 +1,5 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # Copyright (C) 2023 CERN.
4
- #
5
- # Invenio-Cache is free software; you can redistribute it and/or modify
6
- # it under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2023 CERN.
2
+ # SPDX-License-Identifier: MIT
7
3
  """Invenio cache errors."""
8
4
 
9
5
 
@@ -1,11 +1,6 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- # Copyright (C) 2025 Graz University of Technology.
6
- #
7
- # Invenio is free software; you can redistribute it and/or modify it
8
- # under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-FileCopyrightText: 2025 Graz University of Technology.
3
+ # SPDX-License-Identifier: MIT
9
4
 
10
5
  """Cache module for Invenio."""
11
6
 
@@ -1,10 +1,6 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # Copyright (C) 2023 CERN.
4
- # Copyright (C) 2025 Graz University of Technology.
5
- #
6
- # Invenio-Cache is free software; you can redistribute it and/or modify
7
- # it under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2023 CERN.
2
+ # SPDX-FileCopyrightText: 2025 Graz University of Technology.
3
+ # SPDX-License-Identifier: MIT
8
4
  """Lock mechanisms."""
9
5
 
10
6
  from datetime import datetime, timezone
@@ -1,10 +1,5 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-License-Identifier: MIT
8
3
 
9
4
  """Helper proxies."""
10
5
 
@@ -0,0 +1,70 @@
1
+ # SPDX-FileCopyrightText: 2017-2018 CERN.
2
+ # SPDX-FileCopyrightText: 2022-2026 Graz University of Technology.
3
+ # SPDX-FileCopyrightText: 2026 TU Wien.
4
+ # SPDX-License-Identifier: MIT
5
+
6
+ [project]
7
+ name = "invenio-cache"
8
+ description = "Cache module for Invenio."
9
+ readme = "README.rst"
10
+ requires-python = ">=3.9"
11
+ license = "MIT"
12
+ authors = [
13
+ { name = "CERN", email = "info@inveniosoftware.org" },
14
+ ]
15
+ keywords = [
16
+ "cache",
17
+ "invenio",
18
+ ]
19
+ classifiers = [
20
+ "Development Status :: 3 - Alpha",
21
+ ]
22
+ dependencies = [
23
+ "flask-caching>=1.8.0",
24
+ "invenio-base>=2.0.0,<3.0.0",
25
+ ]
26
+ dynamic = ["version"]
27
+
28
+ [project.urls]
29
+ Repository = "https://github.com/inveniosoftware/invenio-cache"
30
+
31
+ [project.entry-points."invenio_base.api_apps"]
32
+ invenio_cache = "invenio_cache:InvenioCache"
33
+
34
+ [project.entry-points."invenio_base.apps"]
35
+ invenio_cache = "invenio_cache:InvenioCache"
36
+
37
+ [project.optional-dependencies]
38
+ tests = [
39
+ "flask-login>=0.6.3",
40
+ "mock>=2.0.0",
41
+ "pytest-black>=0.6.0",
42
+ "pytest-invenio>=4.0.0,<5.0.0",
43
+ "pytest-mock>=1.6.0",
44
+ "redis>=2.10.5",
45
+ "sphinx>=3",
46
+ ]
47
+
48
+ [build-system]
49
+ requires = ["hatchling"]
50
+ build-backend = "hatchling.build"
51
+
52
+ [tool.hatch.version]
53
+ path = "invenio_cache/__init__.py"
54
+
55
+ [tool.hatch.build.targets.sdist]
56
+ include = [
57
+ "/invenio_cache",
58
+ ]
59
+
60
+ [tool.isort]
61
+ profile = "black"
62
+
63
+ [tool.pydocstyle]
64
+ add_ignore = "D401"
65
+
66
+ [tool.pytest.ini_options]
67
+ addopts = '--black --isort --pydocstyle --doctest-glob="*.rst" --doctest-modules --cov=invenio_cache --cov-report=term-missing'
68
+ filterwarnings = ["ignore::pytest.PytestDeprecationWarning"]
69
+ testpaths = "tests invenio_cache"
70
+ live_server_scope = "module"
@@ -1,15 +0,0 @@
1
- .git
2
- *.gitignore
3
-
4
- *.mo
5
- *.pyc
6
- *.swp
7
- *.swo
8
- *.~
9
-
10
- .dockerignore
11
- Dockerfile
12
- docker-compose.yml
13
- docker-compose-dev.yml
14
-
15
- Procfile*
@@ -1,32 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
8
-
9
- root = true
10
-
11
- [*]
12
- indent_style = space
13
- end_of_line = lf
14
- insert_final_newline = true
15
- trim_trailing_whitespace = true
16
- charset = utf-8
17
-
18
- # RST files (used by sphinx)
19
- [*.rst]
20
- indent_size = 4
21
-
22
- # CSS, HTML, JS, JSON, YML
23
- [*.{css,html,js,json,yml}]
24
- indent_size = 2
25
-
26
- # Matches the exact files either package.json or .github/workflows/*.yml
27
- [{package.json, .github/workflows/*.yml}]
28
- indent_size = 2
29
-
30
- # Dockerfile
31
- [Dockerfile]
32
- indent_size = 4
@@ -1 +0,0 @@
1
- e391b1ff85877a455a1a3d780d773bf6f16f457c
@@ -1,11 +0,0 @@
1
- ..
2
- This file is part of Invenio.
3
- Copyright (C) 2017-2018 CERN.
4
-
5
- Invenio is free software; you can redistribute it and/or modify it
6
- under the terms of the MIT License; see LICENSE file for more details.
7
-
8
- Contributors
9
- ============
10
-
11
- - Lars Holm Nielsen
@@ -1,51 +0,0 @@
1
- ..
2
- This file is part of Invenio.
3
- Copyright (C) 2017-2023 CERN.
4
- Copyright (C) 2024-2026 Graz University of Technology.
5
-
6
- Invenio is free software; you can redistribute it and/or modify it
7
- under the terms of the MIT License; see LICENSE file for more details.
8
-
9
- Changes
10
- =======
11
-
12
- Version v3.0.0 (released 2026-01-27)
13
-
14
- - chore(setup): bump pytest-invenio dependency
15
- - chore(black): update formatting to >= 26.0
16
- - fix: PytestMockWarning: Mocks
17
- - fix: DeprecationWarning from flask-caching
18
- - fix(chore): DeprecationWarning stdlib
19
-
20
- Version 2.1.0 (released 2025-07-01)
21
-
22
- - fix: pkg_resources DeprecationWarning
23
-
24
- Version 2.0.0 (released 2024-12-03)
25
-
26
- - setup: replace invenio-accounts with flask-login
27
- - setup: bump major dependencies
28
-
29
- Version 1.3.1 (released 2024-11-28)
30
-
31
- - setup: pin dependencies
32
-
33
- Version 1.3.0 (released 2023-10-02)
34
-
35
- - Add in-process cache decorator
36
-
37
- Version 1.2.0 (released 2023-08-30)
38
-
39
- - Add common mutex lock class
40
-
41
- Version 1.1.1 (released 2022-05-23)
42
-
43
- - Moved from setup.py to setup.cfg
44
-
45
- Version 1.1.0 (released 2020-03-10)
46
-
47
- - changes flask dependency to centrally managed
48
-
49
- Version 1.0.0 (released 2018-03-23)
50
-
51
- - Initial public release.
@@ -1,125 +0,0 @@
1
- ..
2
- This file is part of Invenio.
3
- Copyright (C) 2017-2018 CERN.
4
-
5
- Invenio is free software; you can redistribute it and/or modify it
6
- under the terms of the MIT License; see LICENSE file for more details.
7
-
8
- Contributing
9
- ============
10
-
11
- Contributions are welcome, and they are greatly appreciated! Every
12
- little bit helps, and credit will always be given.
13
-
14
- Types of Contributions
15
- ----------------------
16
-
17
- Report Bugs
18
- ~~~~~~~~~~~
19
-
20
- Report bugs at https://github.com/inveniosoftware/invenio-cache/issues.
21
-
22
- If you are reporting a bug, please include:
23
-
24
- * Your operating system name and version.
25
- * Any details about your local setup that might be helpful in troubleshooting.
26
- * Detailed steps to reproduce the bug.
27
-
28
- Fix Bugs
29
- ~~~~~~~~
30
-
31
- Look through the GitHub issues for bugs. Anything tagged with "bug"
32
- is open to whoever wants to implement it.
33
-
34
- Implement Features
35
- ~~~~~~~~~~~~~~~~~~
36
-
37
- Look through the GitHub issues for features. Anything tagged with "feature"
38
- is open to whoever wants to implement it.
39
-
40
- Write Documentation
41
- ~~~~~~~~~~~~~~~~~~~
42
-
43
- Invenio-Cache could always use more documentation, whether as part of the
44
- official Invenio-Cache docs, in docstrings, or even on the web in blog posts,
45
- articles, and such.
46
-
47
- Submit Feedback
48
- ~~~~~~~~~~~~~~~
49
-
50
- The best way to send feedback is to file an issue at
51
- https://github.com/inveniosoftware/invenio-cache/issues.
52
-
53
- If you are proposing a feature:
54
-
55
- * Explain in detail how it would work.
56
- * Keep the scope as narrow as possible, to make it easier to implement.
57
- * Remember that this is a volunteer-driven project, and that contributions
58
- are welcome :)
59
-
60
- Get Started!
61
- ------------
62
-
63
- Ready to contribute? Here's how to set up `invenio-cache` for local development.
64
-
65
- 1. Fork the `inveniosoftware/invenio-cache` repo on GitHub.
66
- 2. Clone your fork locally:
67
-
68
- .. code-block:: console
69
-
70
- $ git clone git@github.com:your_name_here/invenio-cache.git
71
-
72
- 3. Install your local copy into a virtualenv. Assuming you have
73
- virtualenvwrapper installed, this is how you set up your fork for local
74
- development:
75
-
76
- .. code-block:: console
77
-
78
- $ mkvirtualenv invenio-cache
79
- $ cd invenio-cache/
80
- $ pip install -e .[all]
81
-
82
- 4. Create a branch for local development:
83
-
84
- .. code-block:: console
85
-
86
- $ git checkout -b name-of-your-bugfix-or-feature
87
-
88
- Now you can make your changes locally.
89
-
90
- 5. When you're done making changes, check that your changes pass tests:
91
-
92
- .. code-block:: console
93
-
94
- $ ./run-tests.sh
95
-
96
- The tests will provide you with test coverage and also check PEP8
97
- (code style), PEP257 (documentation), flake8 as well as build the Sphinx
98
- documentation and run doctests.
99
-
100
- 6. Commit your changes and push your branch to GitHub:
101
-
102
- .. code-block:: console
103
-
104
- $ git add .
105
- $ git commit -s
106
- -m "component: title without verbs"
107
- -m "* NEW Adds your new feature."
108
- -m "* FIX Fixes an existing issue."
109
- -m "* BETTER Improves and existing feature."
110
- -m "* Changes something that should not be visible in release notes."
111
- $ git push origin name-of-your-bugfix-or-feature
112
-
113
- 7. Submit a pull request through the GitHub website.
114
-
115
- Pull Request Guidelines
116
- -----------------------
117
-
118
- Before you submit a pull request, check that it meets these guidelines:
119
-
120
- 1. The pull request should include tests and must not decrease test coverage.
121
- 2. If the pull request adds functionality, the docs should be updated. Put
122
- your new functionality into a function with a docstring.
123
- 3. The pull request should work for Python 3.6, 3.7, 3.8 and 3.9. Check
124
- https://github.com/inveniosoftware/invenio-cache/actions?query=event%3Apull_request
125
- and make sure that the tests pass for all supported Python versions.
@@ -1,29 +0,0 @@
1
- ..
2
- This file is part of Invenio.
3
- Copyright (C) 2017-2018 CERN.
4
-
5
- Invenio is free software; you can redistribute it and/or modify it
6
- under the terms of the MIT License; see LICENSE file for more details.
7
-
8
- Installation
9
- ============
10
-
11
- Invenio-Cache is on PyPI so all you need is:
12
-
13
- .. code-block:: console
14
-
15
- $ pip install invenio-cache
16
-
17
- Note, depending on which cache backend you plan yo use, you need to install
18
- extra modules. For instance for Redis you need:
19
-
20
- .. code-block:: console
21
-
22
- $ pip install redis
23
-
24
- For memcached you need either pylibmc or python-memcached installed:
25
-
26
- .. code-block:: console
27
-
28
- $ pip install pylibmc
29
- $ pip install python-memcached
@@ -1,27 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
8
-
9
- include .dockerignore
10
- include .editorconfig
11
- include .tx/config
12
- include *.rst
13
- include *.sh
14
- include *.txt
15
- include LICENSE
16
- include pytest.ini
17
- prune docs/_build
18
- recursive-include docs *.bat
19
- recursive-include docs *.py
20
- recursive-include docs *.rst
21
- recursive-include docs *.txt
22
- recursive-include docs Makefile
23
- recursive-include invenio_cache *.po *.pot *.mo
24
- recursive-include tests *.html
25
- recursive-include tests *.py
26
- recursive-include .github/workflows *.yml
27
- include .git-blame-ignore-revs
@@ -1,105 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: invenio-cache
3
- Version: 3.0.0
4
- Summary: Cache module for Invenio.
5
- Home-page: https://github.com/inveniosoftware/invenio-cache
6
- Author: CERN
7
- Author-email: info@inveniosoftware.org
8
- License: MIT
9
- Keywords: invenio cache
10
- Platform: any
11
- Classifier: Development Status :: 3 - Alpha
12
- Requires-Python: >=3.7
13
- License-File: LICENSE
14
- License-File: AUTHORS.rst
15
- Requires-Dist: Flask-Caching>=1.8.0
16
- Requires-Dist: invenio-base<3.0.0,>=2.0.0
17
- Provides-Extra: tests
18
- Requires-Dist: pytest-black>=0.6.0; extra == "tests"
19
- Requires-Dist: mock>=2.0.0; extra == "tests"
20
- Requires-Dist: redis>=2.10.5; extra == "tests"
21
- Requires-Dist: pytest-invenio<5.0.0,>=4.0.0; extra == "tests"
22
- Requires-Dist: pytest-mock>=1.6.0; extra == "tests"
23
- Requires-Dist: flask-login>=0.6.3; extra == "tests"
24
- Requires-Dist: Sphinx>=3; extra == "tests"
25
- Dynamic: license-file
26
-
27
- ..
28
- This file is part of Invenio.
29
- Copyright (C) 2017-2018 CERN.
30
-
31
- Invenio is free software; you can redistribute it and/or modify it
32
- under the terms of the MIT License; see LICENSE file for more details.
33
-
34
- ===============
35
- Invenio-Cache
36
- ===============
37
-
38
- .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-cache.svg
39
- :target: https://github.com/inveniosoftware/invenio-cache/blob/master/LICENSE
40
-
41
- .. image:: https://github.com/inveniosoftware/invenio-cache/workflows/CI/badge.svg
42
- :target: https://github.com/inveniosoftware/invenio-cache/actions?query=workflow%3ACI
43
-
44
- .. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-cache.svg
45
- :target: https://coveralls.io/r/inveniosoftware/invenio-cache
46
-
47
- .. image:: https://img.shields.io/pypi/v/invenio-cache.svg
48
- :target: https://pypi.org/pypi/invenio-cache
49
-
50
- Cache module for Invenio.
51
-
52
- Further documentation is available on
53
- https://invenio-cache.readthedocs.io/
54
-
55
- ..
56
- This file is part of Invenio.
57
- Copyright (C) 2017-2023 CERN.
58
- Copyright (C) 2024-2026 Graz University of Technology.
59
-
60
- Invenio is free software; you can redistribute it and/or modify it
61
- under the terms of the MIT License; see LICENSE file for more details.
62
-
63
- Changes
64
- =======
65
-
66
- Version v3.0.0 (released 2026-01-27)
67
-
68
- - chore(setup): bump pytest-invenio dependency
69
- - chore(black): update formatting to >= 26.0
70
- - fix: PytestMockWarning: Mocks
71
- - fix: DeprecationWarning from flask-caching
72
- - fix(chore): DeprecationWarning stdlib
73
-
74
- Version 2.1.0 (released 2025-07-01)
75
-
76
- - fix: pkg_resources DeprecationWarning
77
-
78
- Version 2.0.0 (released 2024-12-03)
79
-
80
- - setup: replace invenio-accounts with flask-login
81
- - setup: bump major dependencies
82
-
83
- Version 1.3.1 (released 2024-11-28)
84
-
85
- - setup: pin dependencies
86
-
87
- Version 1.3.0 (released 2023-10-02)
88
-
89
- - Add in-process cache decorator
90
-
91
- Version 1.2.0 (released 2023-08-30)
92
-
93
- - Add common mutex lock class
94
-
95
- Version 1.1.1 (released 2022-05-23)
96
-
97
- - Moved from setup.py to setup.cfg
98
-
99
- Version 1.1.0 (released 2020-03-10)
100
-
101
- - changes flask dependency to centrally managed
102
-
103
- Version 1.0.0 (released 2018-03-23)
104
-
105
- - Initial public release.
@@ -1,17 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
8
-
9
- """Python 2/3 compatibility module."""
10
-
11
- from __future__ import absolute_import, print_function
12
-
13
- import sys
14
-
15
- PY3 = sys.version_info[0] == 3
16
-
17
- string_types = str if PY3 else basestring
@@ -1,105 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: invenio-cache
3
- Version: 3.0.0
4
- Summary: Cache module for Invenio.
5
- Home-page: https://github.com/inveniosoftware/invenio-cache
6
- Author: CERN
7
- Author-email: info@inveniosoftware.org
8
- License: MIT
9
- Keywords: invenio cache
10
- Platform: any
11
- Classifier: Development Status :: 3 - Alpha
12
- Requires-Python: >=3.7
13
- License-File: LICENSE
14
- License-File: AUTHORS.rst
15
- Requires-Dist: Flask-Caching>=1.8.0
16
- Requires-Dist: invenio-base<3.0.0,>=2.0.0
17
- Provides-Extra: tests
18
- Requires-Dist: pytest-black>=0.6.0; extra == "tests"
19
- Requires-Dist: mock>=2.0.0; extra == "tests"
20
- Requires-Dist: redis>=2.10.5; extra == "tests"
21
- Requires-Dist: pytest-invenio<5.0.0,>=4.0.0; extra == "tests"
22
- Requires-Dist: pytest-mock>=1.6.0; extra == "tests"
23
- Requires-Dist: flask-login>=0.6.3; extra == "tests"
24
- Requires-Dist: Sphinx>=3; extra == "tests"
25
- Dynamic: license-file
26
-
27
- ..
28
- This file is part of Invenio.
29
- Copyright (C) 2017-2018 CERN.
30
-
31
- Invenio is free software; you can redistribute it and/or modify it
32
- under the terms of the MIT License; see LICENSE file for more details.
33
-
34
- ===============
35
- Invenio-Cache
36
- ===============
37
-
38
- .. image:: https://img.shields.io/github/license/inveniosoftware/invenio-cache.svg
39
- :target: https://github.com/inveniosoftware/invenio-cache/blob/master/LICENSE
40
-
41
- .. image:: https://github.com/inveniosoftware/invenio-cache/workflows/CI/badge.svg
42
- :target: https://github.com/inveniosoftware/invenio-cache/actions?query=workflow%3ACI
43
-
44
- .. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-cache.svg
45
- :target: https://coveralls.io/r/inveniosoftware/invenio-cache
46
-
47
- .. image:: https://img.shields.io/pypi/v/invenio-cache.svg
48
- :target: https://pypi.org/pypi/invenio-cache
49
-
50
- Cache module for Invenio.
51
-
52
- Further documentation is available on
53
- https://invenio-cache.readthedocs.io/
54
-
55
- ..
56
- This file is part of Invenio.
57
- Copyright (C) 2017-2023 CERN.
58
- Copyright (C) 2024-2026 Graz University of Technology.
59
-
60
- Invenio is free software; you can redistribute it and/or modify it
61
- under the terms of the MIT License; see LICENSE file for more details.
62
-
63
- Changes
64
- =======
65
-
66
- Version v3.0.0 (released 2026-01-27)
67
-
68
- - chore(setup): bump pytest-invenio dependency
69
- - chore(black): update formatting to >= 26.0
70
- - fix: PytestMockWarning: Mocks
71
- - fix: DeprecationWarning from flask-caching
72
- - fix(chore): DeprecationWarning stdlib
73
-
74
- Version 2.1.0 (released 2025-07-01)
75
-
76
- - fix: pkg_resources DeprecationWarning
77
-
78
- Version 2.0.0 (released 2024-12-03)
79
-
80
- - setup: replace invenio-accounts with flask-login
81
- - setup: bump major dependencies
82
-
83
- Version 1.3.1 (released 2024-11-28)
84
-
85
- - setup: pin dependencies
86
-
87
- Version 1.3.0 (released 2023-10-02)
88
-
89
- - Add in-process cache decorator
90
-
91
- Version 1.2.0 (released 2023-08-30)
92
-
93
- - Add common mutex lock class
94
-
95
- Version 1.1.1 (released 2022-05-23)
96
-
97
- - Moved from setup.py to setup.cfg
98
-
99
- Version 1.1.0 (released 2020-03-10)
100
-
101
- - changes flask dependency to centrally managed
102
-
103
- Version 1.0.0 (released 2018-03-23)
104
-
105
- - Initial public release.
@@ -1,31 +0,0 @@
1
- .dockerignore
2
- .editorconfig
3
- .git-blame-ignore-revs
4
- AUTHORS.rst
5
- CHANGES.rst
6
- CONTRIBUTING.rst
7
- INSTALL.rst
8
- LICENSE
9
- MANIFEST.in
10
- README.rst
11
- pyproject.toml
12
- requirements-devel.txt
13
- run-tests.sh
14
- setup.cfg
15
- setup.py
16
- invenio_cache/__init__.py
17
- invenio_cache/_compat.py
18
- invenio_cache/bccache.py
19
- invenio_cache/config.py
20
- invenio_cache/decorators.py
21
- invenio_cache/errors.py
22
- invenio_cache/ext.py
23
- invenio_cache/lock.py
24
- invenio_cache/proxies.py
25
- invenio_cache.egg-info/PKG-INFO
26
- invenio_cache.egg-info/SOURCES.txt
27
- invenio_cache.egg-info/dependency_links.txt
28
- invenio_cache.egg-info/entry_points.txt
29
- invenio_cache.egg-info/not-zip-safe
30
- invenio_cache.egg-info/requires.txt
31
- invenio_cache.egg-info/top_level.txt
@@ -1,5 +0,0 @@
1
- [invenio_base.api_apps]
2
- invenio_cache = invenio_cache:InvenioCache
3
-
4
- [invenio_base.apps]
5
- invenio_cache = invenio_cache:InvenioCache
@@ -1,11 +0,0 @@
1
- Flask-Caching>=1.8.0
2
- invenio-base<3.0.0,>=2.0.0
3
-
4
- [tests]
5
- pytest-black>=0.6.0
6
- mock>=2.0.0
7
- redis>=2.10.5
8
- pytest-invenio<5.0.0,>=4.0.0
9
- pytest-mock>=1.6.0
10
- flask-login>=0.6.3
11
- Sphinx>=3
@@ -1 +0,0 @@
1
- invenio_cache
@@ -1,5 +0,0 @@
1
-
2
- [build-system]
3
- requires = ["setuptools", "wheel", "babel>2.8"]
4
- build-backend = "setuptools.build_meta"
5
-
@@ -1,10 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
8
-
9
- -e git+https://github.com/sh4nks/flask-caching.git#egg=Flask-Caching
10
- -e git+https://github.com/inveniosoftware/invenio-base.git#egg=invenio-base
@@ -1,28 +0,0 @@
1
- #!/usr/bin/env bash
2
- # -*- coding: utf-8 -*-
3
- #
4
- # This file is part of Invenio.
5
- # Copyright (C) 2020 CERN.
6
- # Copyright (C) 2022 Graz University of Technology.
7
- #
8
- # Invenio is free software; you can redistribute it and/or modify it
9
- # under the terms of the MIT License; see LICENSE file for more details.
10
-
11
- # Quit on errors
12
- set -o errexit
13
-
14
- # Quit on unbound symbols
15
- set -o nounset
16
-
17
- # Always bring down docker services
18
- function cleanup() {
19
- eval "$(docker-services-cli down --env)"
20
- }
21
- trap cleanup EXIT
22
-
23
- python -m check_manifest
24
- python -m sphinx.cmd.build -qnNW docs docs/_build/html
25
- eval "$(docker-services-cli up --cache ${CACHE:-redis} --env)"
26
- python -m pytest
27
- tests_exit_code=$?
28
- exit "$tests_exit_code"
@@ -1,66 +0,0 @@
1
- [metadata]
2
- name = invenio-cache
3
- version = attr: invenio_cache.__version__
4
- description = Cache module for Invenio.
5
- long_description = file: README.rst, CHANGES.rst
6
- keywords = invenio cache
7
- license = MIT
8
- author = CERN
9
- author_email = info@inveniosoftware.org
10
- platforms = any
11
- url = https://github.com/inveniosoftware/invenio-cache
12
- classifiers =
13
- Development Status :: 3 - Alpha
14
-
15
- [options]
16
- include_package_data = True
17
- packages = find:
18
- python_requires = >=3.7
19
- zip_safe = False
20
- install_requires =
21
- Flask-Caching>=1.8.0
22
- invenio-base>=2.0.0,<3.0.0
23
-
24
- [options.extras_require]
25
- tests =
26
- pytest-black>=0.6.0
27
- mock>=2.0.0
28
- redis>=2.10.5
29
- pytest-invenio>=4.0.0,<5.0.0
30
- pytest-mock>=1.6.0
31
- flask-login>=0.6.3
32
- Sphinx>=3
33
-
34
- [options.entry_points]
35
- invenio_base.apps =
36
- invenio_cache = invenio_cache:InvenioCache
37
- invenio_base.api_apps =
38
- invenio_cache = invenio_cache:InvenioCache
39
-
40
- [build_sphinx]
41
- source-dir = docs/
42
- build-dir = docs/_build
43
- all_files = 1
44
-
45
- [bdist_wheel]
46
- universal = 1
47
-
48
- [pydocstyle]
49
- add_ignore = D401
50
-
51
- [isort]
52
- profile = black
53
-
54
- [check-manifest]
55
- ignore =
56
- *-requirements.txt
57
-
58
- [tool:pytest]
59
- addopts = --black --isort --pydocstyle --doctest-glob="*.rst" --doctest-modules --cov=invenio_cache --cov-report=term-missing
60
- testpaths = tests invenio_cache
61
- filterwarnings = ignore::pytest.PytestDeprecationWarning
62
-
63
- [egg_info]
64
- tag_build =
65
- tag_date = 0
66
-
@@ -1,13 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # This file is part of Invenio.
4
- # Copyright (C) 2017-2018 CERN.
5
- #
6
- # Invenio is free software; you can redistribute it and/or modify it
7
- # under the terms of the MIT License; see LICENSE file for more details.
8
-
9
- """Cache module for Invenio."""
10
-
11
- from setuptools import setup
12
-
13
- setup()
File without changes