Merge pull request #18 from ycharts/version_1

Major Upgrades

Author: KFoxder

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,4 +4,3 @@ A few sentences or bullet points describing the overall goals and what changed.
 ### How to test
 - [ ] Step 1 to test the changes you made
 - [ ] Step 2 to test the changes you made
-

.github/workflows/canceller.yml

@@ -1,50 +1,38 @@
-name: Test Suite # IMPORTANT: If this name changes you need to update the canceller.yml
+name: Test Suite
 
 # Controls when the action will run.
 on:
   # Triggers the workflow on push for the master branch.
   push:
     branches: [ master ]
-
   # Triggers the workflow on pull request for any branch.
   pull_request:
-
   # Allows you to run this workflow manually from the Actions tab.
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.4, 3.5, 3.6, 3.7 ]
-        django-version: [ 1.7.*, 1.8.*, 1.9.*, 1.10.*, 1.11.*, 2.0.*, 2.1.*, 2.2.*, 3.0.* ]
-        exclude:
-          - python-version: 3.4
-            django-version: 2.1.*
-          - python-version: 3.4
-            django-version: 2.2.*
-          - python-version: 3.4
-            django-version: 3.0.*
-          - python-version: 3.5
-            django-version: 1.7.*
-          - python-version: 3.5
-            django-version: 3.0.*
-          - python-version: 3.6
-            django-version: 1.7.*
-          - python-version: 3.7
-            django-version: 1.7.*
-    defaults:
-      run:
-        shell: bash
+        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
+        django-version: [ "3.2" ]
     steps:
       # Checks-out the  repository.
       - uses: actions/checkout@v2
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: |
+            requirements.txt
+            dev_requirements.txt
 
       - name: Install Python dependencies
         run: |
@@ -56,5 +44,28 @@ jobs:
         run: pip install -e .
 
       - name: Run tests
-        run: python manage.py test
+        run: |
+          coverage run --source='../cache_helper' --data-file='../.coverage.${{ matrix.python-version }}.${{ matrix.django-version }}' manage.py test
         working-directory: ./test_project
+
+      - name: Create LCOV file
+        run: |
+          coverage lcov --data-file='.coverage.${{ matrix.python-version }}.${{ matrix.django-version }}'
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: run-${{ matrix.python-version }}-${{ matrix.django-version }}
+          path-to-lcov: coverage.lcov
+          parallel: true
+
+  finish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

.github/workflows/main.yml

@@ -7,3 +7,7 @@
 *.un~
 .idea
 build/
+*.egg-info
+.coverage
+**/htmlcov/**
+dist/*

.gitignore

@@ -0,0 +1,13 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+    -   id: check-ast
+
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+# Create Release
+
+1. `rm -rf dist`
+1. Update version in `cache_helper/__init__.py`
+1. `pip install -r requirements.txt`
+1. `python -m build`
+1. `twine upload dist/*`

DEVELOPMENT.md

@@ -1,26 +1,84 @@
 django-cache-helper
 ===================
 
-## Support
-**Python:** 3.4, 3.5, 3.6, 3.7
-
-**Django:** 1.7, 1.8, 1.9, 1.10, 1.11, 2.0, 2.1, 2.2, 3.0 
+ 
+![PyPI](https://img.shields.io/pypi/v/django-cache-helper?color=green)
+[![Test Suite](https://github.com/ycharts/django_cache_helper/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/ycharts/django_cache_helper/actions/workflows/main.yml)
+[![Coverage Status](https://coveralls.io/repos/github/ycharts/django_cache_helper/badge.svg?branch=master)](https://coveralls.io/github/ycharts/django_cache_helper?branch=master)
 
 ## Overview
 django-cache-helper is a simple tool for making caching functions, methods, and class methods a little bit easier.
 It is largely based off of django-cache-utils, however, since cache-utils did not support caching model methods by instance and carried other features I didn't need, django-cache-helper was created.
 
-In order to cache a function/method/class_method:
+In order to cache and invalidate a function/method/class_method/static_method:
+
+## Support
+
+| Python | Django |
+|--------|--------|
+|  3.7, 3.8, 3.9, 3.10      | 3.2    |
+
+
+#### How to Cache
 
 ```python
-@cached(60*60)
+# Caching a function
+@cached(60*60)  # 60 Minutes
 def foo(bar):
 	return bar
 
-@property
-@cached(60*60)
-def foo(self):
-	return self.id + 2
+class Incrementer:
+
+    @cached_instance_method(60 * 60)
+    def instance_increment_by(self, num):
+        return num
+
+    @classmethod
+    @cached_class_method(60 * 60)
+    def class_increment_by(cls, num):
+        return num
+
+    @staticmethod
+    @cached(60 * 60)
+    def get_datetime():
+        return datetime.utcnow()
 ```
 
+#### How to invalidate a cache
+
+```python
+
+foo(1)
+foo.invalidate(1)
+
+Incrementer.instance_increment_by(1)
+Incrementer.instance_increment_by.invalidate(1)
+
+Incrementer.class_increment_by(1)
+Incrementer.class_increment_by.invalidate(1)
+
+Incrementer.get_datetime()
+Incrementer.get_datetime.invalidate()
+```
+
+
+## Contributors ✨
+
+Thanks goes to these wonderful people.
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><img src="https://avatars.githubusercontent.com/u/2000316?v=4" width="100px;" alt="Kevin Fox"/><br /><sub><b>Kevin Fox</b></sub></td>
+    <td align="center"><img src="https://avatars.githubusercontent.com/u/3022071?v=4" width="100px;" alt="Tom Jakeway"/><br /><sub><b>Tom Jakeway</b></sub></td>
+    <td align="center"><img src="https://avatars.githubusercontent.com/u/83293?v=4" width="100px;" alt="Ara Anjargolian"/><br /><sub><b>Ara Anjargolian</b></sub></td>
+    <td align="center"><img src="https://avatars.githubusercontent.com/u/15602942?v=4" width="100px;" alt="Hyuckin David Lim"/><br /><sub><b>Hyuckin David Lim</b></sub></td>
+    <td align="center"><img src="https://avatars.githubusercontent.com/u/1248116?v=4" width="100px;" alt="James"/><br /><sub><b>James</b></sub></td>
+  </tr>
+</table>
 
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->

README.md

@@ -0,0 +1 @@
+VERSION = (1, 0, 0)

cache_helper/__init__.py

@@ -10,8 +10,8 @@
 
 from cache_helper import utils
 
-def cached(timeout):
 
+def cached(timeout):
     def _cached(func):
         func_name = utils.get_function_name(func)
 
@@ -57,14 +57,15 @@ def invalidate(*args, **kwargs):
 
 
 def cached_class_method(timeout):
-
     def _cached(func):
         func_name = utils.get_function_name(func)
 
         @wraps(func)
         def wrapper(*args, **kwargs):
             # skip the first arg because it will be the class itself
-            function_cache_key = utils.get_function_cache_key(func_name, args[1:], kwargs)
+            function_cache_key = utils.get_function_cache_key(
+                func_name, args[1:], kwargs
+            )
             cache_key = utils.get_hashed_cache_key(function_cache_key)
 
             try:

cache_helper/decorators.py

@@ -1,5 +1,6 @@
 class CacheHelperException(Exception):
     pass
 
+
 class CacheKeyCreationError(CacheHelperException):
     pass