btrcache 0.1.0__tar.gz

btrcache-0.1.0/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: "lucas-azdias"
+ko_fi: "lucasazdias"

btrcache-0.1.0/.github/release.yml

@@ -0,0 +1,23 @@
+changelog:
+    categories:
+        - title: New Features 🎉
+          labels:
+              - feature
+
+        - title: Bug Fixes 🐛
+          labels:
+              - bug
+
+        - title: Documentation 📚
+          labels:
+              - documentation
+
+        - title: Maintenance 🔧
+          labels:
+              - dependencies
+              - ci
+              - chore
+
+        - title: Other Changes 🔄
+          labels:
+              - "*"

btrcache-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,136 @@
+name: Publish
+
+on:
+    push:
+        tags:
+            - "v*.*.*"
+
+env:
+    PACKAGE_NAME: btrcache
+    OWNER_NAME: lucas.azdias
+
+jobs:
+    check:
+        name: Checking new release information
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Verifying workflow trigger
+              run: |
+                  if [ "$GITHUB_REF_TYPE" != "tag" ]; then
+                      echo "This workflow must be run from a tag."
+                      exit 1
+                  fi
+
+            - name: Extracting new version
+              id: extract
+              run: |
+                  echo "NEW_VERSION=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
+
+            - name: Installing jq
+              run: sudo apt update && sudo apt install -y jq
+
+            - name: Fetching package latest version on PyPI
+              id: fetch
+              run: |
+                  latest=$(curl -fsSL "https://pypi.org/pypi/$PACKAGE_NAME/json" |
+                      jq -r '.info.version // "0.0.0"')
+
+                  echo "LATEST_VERSION=$latest" >> "$GITHUB_OUTPUT"
+
+            - name: Comparing versions
+              env:
+                  NEW_VERSION: ${{ steps.extract.outputs.NEW_VERSION }}
+                  LATEST_VERSION: ${{ steps.fetch.outputs.LATEST_VERSION }}
+              run: |
+                  HIGHEST=$(printf '%s\n%s\n' "$LATEST_VERSION" "$NEW_VERSION" | sort -V | tail -n1)
+
+                  if [ "$HIGHEST" != "$NEW_VERSION" ] || [ "$NEW_VERSION" = "$LATEST_VERSION" ]; then
+                      echo "Version $NEW_VERSION is not newer than $LATEST_VERSION."
+                      exit 1
+                  fi
+
+                  echo "Version check passed."
+
+    tests:
+        name: Testing
+        uses: ./.github/workflows/tests.yml
+
+    build:
+        name: Building
+        needs: [check, tests]
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Doing checkout
+              uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+            - name: "Setting up Python"
+              uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+              with:
+                  python-version-file: ".python-version"
+
+            - name: Installing `uv`
+              uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+            - name: Syncing dependencies
+              run: uv sync --frozen
+
+            - name: Building redistributables
+              run: uv build
+
+            - name: Uploading artifacts
+              uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+              with:
+                  name: ${{ env.PACKAGE_NAME }}-dist
+                  path: dist/*
+
+    pypi_publish:
+        name: PyPI publishing
+        needs: build
+
+        runs-on: ubuntu-latest
+
+        environment:
+            name: pypi
+
+        permissions:
+            id-token: write
+
+        steps:
+            - name: Downloading artifacts
+              uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+              with:
+                  name: ${{ env.PACKAGE_NAME }}-dist
+                  path: dist
+
+            - name: Installing `uv`
+              uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+            - name: Publishing redistributables
+              run: uv publish dist/*
+
+    github_release:
+        name: Releasing on Github
+        needs: build
+
+        runs-on: ubuntu-latest
+
+        permissions:
+            contents: write
+
+        steps:
+            - name: Downloading artifacts
+              uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+              with:
+                  name: ${{ env.PACKAGE_NAME }}-dist
+                  path: dist
+
+            - name: Creating release
+              uses: softprops/action-gh-release@2bb465e97f322d3cb2a965294d483e0d26a67aa9 # v3.0.1
+              with:
+                  files: dist/*.whl,dist/*.tar.gz
+                  make_latest: true
+                  generate_release_notes: true

btrcache-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,46 @@
+name: Tests
+
+on:
+    workflow_call:
+    push:
+        branches:
+            - "*"
+    pull_request:
+        branches:
+            - main
+            - develop
+
+jobs:
+    code_qa:
+        name: Code quality assurance testing
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Doing checkout
+              uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+            - name: "Setting up Python"
+              uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+              with:
+                  python-version-file: ".python-version"
+
+            - name: Installing `uv`
+              uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+            - name: Syncing dependencies
+              run: uv sync --dev --frozen
+
+            - name: Validating typing
+              run: uv run poe types
+
+            - name: Validating formatting
+              run: uv run poe check
+
+            - name: Running `pytest` tests
+              run: uv run poe tests
+
+            - name: Uploading coverage reports to Codecov
+              uses: codecov/codecov-action@e53489f4d376d79066609109e7a95a29eb3740b1 #v7.0.0
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}

btrcache-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+__version__.py
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

btrcache-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+    - repo: https://github.com/RobertCraigie/pyright-python
+      rev: v1.1.411
+      hooks:
+          - id: pyright
+
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.15.16
+      hooks:
+          - id: ruff-format
+          - id: ruff-check
+            args: ["--fix"]

btrcache-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

btrcache-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lucas Dias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

btrcache-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: btrcache
+Version: 0.1.0
+Summary: High-performance caching tools, memoization decorators, and cache collections for Python.
+Project-URL: Homepage, https://github.com/lucas-azdias/btrcache?tab=readme-ov-file
+Project-URL: Source, https://github.com/lucas-azdias/btrcache
+Project-URL: Issues, https://github.com/lucas-azdias/btrcache/issues
+Author-email: Lucas Dias <lucas@azdias.com.br>
+Maintainer-email: Lucas Dias <lucas@azdias.com.br>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# `btrcache`
+
+[![License](https://img.shields.io/github/license/lucas-azdias/btrcache)](https://raw.github.com/lucas-azdias/btrcache/master/LICENSE)
+
+[![Coverage](https://img.shields.io/codecov/c/github/lucas-azdias/btrcache/main.svg)](https://codecov.io/gh/lucas-azdias/btrcache)
+
+High-performance caching tools, memoization decorators, and cache collections for Python.
+
+---
+
+## Overview
+
+**`btrcache`** is a Python library that provides a flexible set of in-memory caching primitives, decorators, and cache collections designed for both synchronous and asynchronous workloads.
+
+## Installation
+
+```bash
+pip install btrcache
+```
+
+<!--
+## Quick Start
+
+### Simple function memoization
+
+```python
+from btrcache import cached
+
+@cached()
+def fib(n: int) -> int:
+    if n < 2:
+        return n
+    return fib(n - 1) + fib(n - 2)
+```
+
+### Custom cache size
+
+```python
+from btrcache import cached, LRUCache
+
+@cached(cache_factory=lambda: LRUCache(maxsize=1024))
+def compute(x):
+    return x * x
+```
+-->
+
+## Roadmap
+
+* [X] Key generators
+* [X] Asynchronous decorators
+* [ ] Create tests
+* [ ] Release in PyPi
+* [ ] Synchronous decorators
+* [ ] Cache collections
+* [ ] Optimizations
+
+## Contributing
+
+Contributions are welcome. Please ensure:
+
+* Code is type-annotated;
+* Tests cover edge cases.
+
+## Acknowledgements
+
+This project builds upon ideas and implementations from the following open-source projects:
+
+- [`cachetools`](https://github.com/tkem/cachetools/) - An extensible set of memoizing collections and decorators for Python. Developed and maintained by [Thomas Kemmer](https://github.com/tkem/).
+- [`cachetools-async`](https://github.com/imnotjames/cachetools-async/) - Python library that extends `cachetools` with async decorators. Created by [James Ward](https://github.com/imnotjames/).
+
+## License
+
+Copyright (C) 2026 Lucas Dias.
+
+Licensed under the [MIT License](LICENSE).

btrcache-0.1.0/README.md

@@ -0,0 +1,75 @@
+# `btrcache`
+
+[![License](https://img.shields.io/github/license/lucas-azdias/btrcache)](https://raw.github.com/lucas-azdias/btrcache/master/LICENSE)
+
+[![Coverage](https://img.shields.io/codecov/c/github/lucas-azdias/btrcache/main.svg)](https://codecov.io/gh/lucas-azdias/btrcache)
+
+High-performance caching tools, memoization decorators, and cache collections for Python.
+
+---
+
+## Overview
+
+**`btrcache`** is a Python library that provides a flexible set of in-memory caching primitives, decorators, and cache collections designed for both synchronous and asynchronous workloads.
+
+## Installation
+
+```bash
+pip install btrcache
+```
+
+<!--
+## Quick Start
+
+### Simple function memoization
+
+```python
+from btrcache import cached
+
+@cached()
+def fib(n: int) -> int:
+    if n < 2:
+        return n
+    return fib(n - 1) + fib(n - 2)
+```
+
+### Custom cache size
+
+```python
+from btrcache import cached, LRUCache
+
+@cached(cache_factory=lambda: LRUCache(maxsize=1024))
+def compute(x):
+    return x * x
+```
+-->
+
+## Roadmap
+
+* [X] Key generators
+* [X] Asynchronous decorators
+* [ ] Create tests
+* [ ] Release in PyPi
+* [ ] Synchronous decorators
+* [ ] Cache collections
+* [ ] Optimizations
+
+## Contributing
+
+Contributions are welcome. Please ensure:
+
+* Code is type-annotated;
+* Tests cover edge cases.
+
+## Acknowledgements
+
+This project builds upon ideas and implementations from the following open-source projects:
+
+- [`cachetools`](https://github.com/tkem/cachetools/) - An extensible set of memoizing collections and decorators for Python. Developed and maintained by [Thomas Kemmer](https://github.com/tkem/).
+- [`cachetools-async`](https://github.com/imnotjames/cachetools-async/) - Python library that extends `cachetools` with async decorators. Created by [James Ward](https://github.com/imnotjames/).
+
+## License
+
+Copyright (C) 2026 Lucas Dias.
+
+Licensed under the [MIT License](LICENSE).