use a GA caching scheme (#15)

Author: escherba

.github/workflows/build-test.yml

@@ -22,15 +22,29 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64
+
+    # block below based on:
+    # https://medium.com/ai2-blog/python-caching-in-github-actions-e9452698e98d
+    - uses: actions/cache@v2
+      with:
+        path: ${{ env.pythonLocation }}
+        key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('pip-freeze.txt') }}
+
     - name: Install dependencies
       run: |
-        pip install setuptools wheel
-        pip install -r requirements.txt
-        pip install .
+        pip install --upgrade --upgrade-strategy eager setuptools wheel
+        pip install --upgrade --upgrade-strategy eager -r requirements.txt
+        pip install --upgrade --upgrade-strategy eager -e .
+        pip freeze > pip-freeze.txt
+
     - name: Test with pytest
-      run: python -m pytest
+      run: |
+        python setup.py build_ext --inplace
+        pip install -e .
+        python -m pytest

README.rst

@@ -110,7 +110,7 @@ commands:
 
     git clone https://github.com/escherba/python-metrohash.git
     cd python-metrohash
-    make env           # creates a Python virtualenv
+    make env           # create a Python virtualenv
     make test          # run Python tests
     make cpp-test      # run C++ tests
 

pip-freeze.txt

@@ -2,32 +2,27 @@ attrs==21.4.0
 backcall==0.2.0
 Cython==0.29.26
 decorator==5.1.0
-distlib==0.3.4
-filelock==3.4.2
 importlib-metadata==4.10.0
 iniconfig==1.1.1
 ipdb==0.13.9
 ipython==7.30.1
 jedi==0.18.1
 matplotlib-inline==0.1.3
--e git+https://github.com/escherba/python-metrohash@c0d6ef1dac61d9cfb3cba5bb8533f69df3c445e6#egg=metrohash
+-e git+https://github.com/escherba/python-metrohash@03ec8e4b0b21bf4a9726b3625d5ebc6e791b2a82#egg=metrohash
 numpy==1.21.5
 packaging==21.3
 parso==0.8.3
 pexpect==4.8.0
 pickleshare==0.7.5
-platformdirs==2.4.1
 pluggy==1.0.0
 prompt-toolkit==3.0.24
 ptyprocess==0.7.0
 py==1.11.0
 Pygments==2.11.0
 pyparsing==3.0.6
 pytest==6.2.5
-six==1.16.0
 toml==0.10.2
 traitlets==5.1.1
 typing_extensions==4.0.1
-virtualenv==20.11.2
 wcwidth==0.2.5
 zipp==3.7.0

requirements.txt

@@ -3,5 +3,3 @@ ipdb
 ipython
 numpy
 pytest
-setuptools
-virtualenv

setup.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 import os
-import warnings
 from os.path import join, dirname
 from setuptools import setup
 from setuptools.extension import Extension
@@ -32,8 +31,9 @@ def is_pure(self):
 
 CXXFLAGS = []
 
+print(f"building for platform: {os.name}")
 if os.name == "nt":
-    CXXFLAGS.extend(["/O3"])
+    CXXFLAGS.extend(["/O2"])
 else:
     CXXFLAGS.extend([
         "-O3",
@@ -43,10 +43,10 @@ def is_pure(self):
 
 
 if 'sse4_2' in CPU_FLAGS:
-    warnings.warn("Compiling with SSE4.2 enabled")
+    print("Compiling with SSE4.2 enabled")
     CXXFLAGS.append('-msse4.2')
 else:
-    warnings.warn("compiling without SSE4.2 support")
+    print("compiling without SSE4.2 support")
 
 
 INCLUDE_DIRS = ['include']
@@ -67,6 +67,7 @@ def is_pure(self):
 EXT_MODULES = []
 
 if USE_CYTHON:
+    print("building extension using Cython")
     CMDCLASS['build_ext'] = build_ext
     EXT_MODULES.append(
         Extension(
@@ -79,6 +80,7 @@ def is_pure(self):
         )
     )
 else:
+    print("building extension w/o Cython")
     EXT_MODULES.append(
         Extension(
             "metrohash",
@@ -91,7 +93,7 @@ def is_pure(self):
     )
 
 
-VERSION = '0.1.1.post1'
+VERSION = '0.1.1.post2'
 URL = "https://github.com/escherba/python-metrohash"
 
 

src/metrohash.cpp

@@ -10,7 +10,7 @@ Python wrapper for MetroHash, a fast non-cryptographic hashing algorithm
 
 __author__  = "Eugene Scherba"
 __email__   = "escherba+metrohash@gmail.com"
-__version__ = "0.1.1.post1"
+__version__ = "0.1.1.post2"
 __all__     = [
     "metrohash64",
     "metrohash128",
@@ -325,7 +325,7 @@ cdef class MetroHash64(object):
     def hexdigest(self) -> str:
         """Obtain a string digest in hexadecimal form
         Returns:
-            bytes: hash string
+            str: hash string
         """
         return bytes2hex(self.digest())
 
@@ -409,7 +409,7 @@ cdef class MetroHash128(object):
     def hexdigest(self) -> str:
         """Obtain a string digest in hexadecimal form
         Returns:
-            bytes: hash string
+            str: hash string
         """
         return bytes2hex(self.digest())