initial (#126)

Author: chayim

.circleci/circle_requirements.txt

@@ -0,0 +1,3 @@
+poetry>=1.1.6
+tox>=3.23.1
+tox-poetry>=0.3.0

.circleci/config.yml

@@ -1,96 +1,99 @@
 version: 2.1
 
 commands:
-  test-steps:
-    parameters:
-      python_ver:
-        type: string
-        default: "3"
-      redisearch_ver:
-        type: string
-        default: edge
-      coverage:
-        type: boolean
-        default: true
-    steps: 
+
+  abort_for_docs:
+    steps:
+      - run:
+          name: Avoid tests for docs
+          command: |
+            if [[ $CIRCLE_BRANCH == *docs ]]; then
+              echo "Identifies as documents PR, no testing required"
+              circleci step halt
+            fi
+
+  abort_for_noci:
+    steps:
+      - run:
+          name: Ignore CI for specific branches
+          command: |
+            if [[ $CIRCLE_BRANCH == *noci ]]; then
+              echo "Identifies as actively ignoring CI, no testing required."
+              circleci step halt
+            fi
+
+
+  early_return_for_forked_pull_requests:
+    description: >-
+      If this build is from a fork, stop executing the current job and return success.
+      This is useful to avoid steps that will fail due to missing credentials.
+    steps:
+      - run:
+          name: Early return if this build is from a forked PR
+          command: |
+            if [[ -n "$CIRCLE_PR_NUMBER" ]]; then
+              echo "Nothing to do for forked PRs, so marking this step successful"
+              circleci step halt
+            fi
+
+  build_and_test:
+    steps:
+      - abort_for_docs
+      - abort_for_noci
       - checkout
 
       - restore_cache: # Download and cache dependencies
           keys:
-          - v1-dependencies-{{ checksum "requirements.txt" }}
+          - v1-dependencies-{{ checksum "pyproject.toml" }}
           # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
 
+      - run:
+          name: install tox dependencies
+          command: |
+            pip install --user --quiet -r .circleci/circle_requirements.txt
+
       - run:
           name: install dependencies
           command: |
-            virtualenv venv
-            . venv/bin/activate
-            python --version
-            pip install -r requirements.txt
-            pip install --force-reinstall git+https://github.com/RedisLabs/rmtest.git
-            <<# parameters.coverage >> pip install codecov <</ parameters.coverage >>
-            python - \<<'__'
-            import redis
-            r = redis.Redis(decode_responses=True)
-            print(r.execute_command('info server'))
-            print(r.execute_command('info modules'))
-            __
-            
-      - save_cache:
-          paths:
-            - ./venv
-          key: v1-dependencies-{{ checksum "requirements.txt" }}
+            poetry install
 
       - run:
-          name: test dist
-          command: python setup.py sdist
+          name: build sdist and wheels
+          command: |
+            poetry build
 
       - run:
-          name: run tests
+          name: lint
           command: |
-            . venv/bin/activate
-            <<# parameters.coverage >> COV=1 <</ parameters.coverage >>
-            if [[ $COV == 1 ]]; then
-                REDIS_PORT=6379 coverage run test/test.py
-                REDIS_PORT=6379 coverage run -a test/test_builder.py
-                codecov
-            else
-                REDIS_PORT=6379 python test/test.py
-                REDIS_PORT=6379 python test/test_builder.py
-            fi
+            tox -e linters
+
+      - run:
+          name: run tests
+          command:
+            tox -e cover
+
+      - save_cache:
+          paths:
+            - ./.tox
+            - ~/.cache/pip
+          key: v1-dependencies-{{ checksum "pyproject.toml" }}
 
       - store_artifacts:
           path: test-reports
           destination: test-reports
 
-
 jobs:
-  test:
+  build:
     parameters:
-      python_ver:
-        type: string
-        default: "3"
-      redisearch_ver:
+      python_version:
         type: string
-        default: edge
-      coverage:
-        type: boolean
-        default: true
+        default: latest
     docker:
-      - image: circleci/python:<<parameters.python_ver >>
-      - image: redislabs/redisearch:<<parameters.redisearch_ver >>
+      - image: circleci/python:<<parameters.python_version >>
+      - image: redislabs/redisearch:edge
     steps:
-      - test-steps:
-          python_ver: <<parameters.python_ver>>
-          redisearch_ver: <<parameters.redisearch_ver>>
-          coverage: <<parameters.coverage>>
-      - store_artifacts:
-          path: test-reports
-          destination: test-reports
-
-    working_directory: ~/repo
-
+      - build_and_test
 
 on-any-branch: &on-any-branch
   filters:
@@ -99,71 +102,35 @@ on-any-branch: &on-any-branch
     tags:
       only: /.*/
 
-never: &never
-  filters:
-    branches:
-      ignore: /.*/
-    tags:
-      ignore: /.*/
-
 on-master: &on-master
-  filters:
-    branches:
-      only: master
-
-on-version-tags: &on-version-tags
-  filters:
-    branches:
-      ignore: /.*/
-    tags:
-      only: /^v[0-9].*/
-
-on-master-and-version-tags: &on-master-and-version-tags
   filters:
     branches:
       only:
         - master
-    tags:
-      only: /^v[0-9].*/ 
 
+# the is to build and test, per commit against all supported python versions
+python-versions: &python-versions
+  matrix:
+    parameters:
+      python_version:
+        - "3.6.9"
+        - "3.7.9"
+        - "3.8.9"
+        - "3.9.4"
+        - "latest"
 
 workflows:
   version: 2
   commit:
     jobs:
-      - test:
-          name: build
-          python_ver: "3"
-          redisearch_ver: edge
-          coverage: yes
-          <<: *on-any-branch
-      - test:
-          name: test_py2_latest
-          python_ver: "2.7"
-          redisearch_ver: edge
-          coverage: yes
-          <<: *on-any-branch
-      - test:
-          name: test_py3_search1.6
-          python_ver: "3"
-          redisearch_ver: "1.6.14"
-          coverage: yes
-          <<: *on-any-branch
-      - test:
-          name: test_py2_search1.6
-          python_ver: "2.7"
-          redisearch_ver: "1.6.14"
-          coverage: yes
-          <<: *on-any-branch
+      - build:
+         <<: *on-any-branch
+         <<: *python-versions
 
   nightly:
     triggers:
       - schedule:
           cron: "0 0 * * *"
           <<: *on-master
     jobs:
-      - test:
-          name: test-nightly
-          python_ver: "3"
-          redisearch_ver: edge
-          coverage: no
+      - build

.github/workflows/publish-pypi.yml

@@ -1,50 +1,43 @@
 name: Publish Pypi
 on:
   release:
-    types: [published]
+    types: [ published ]
 
 jobs:
-  publish:
-    name: publish
+  pytest:
+    name: Publish to PyPi
     runs-on: ubuntu-latest
+    env:
+      ACTIONS_ALLOW_UNSECURE_COMMANDS: true
     steps:
       - uses: actions/checkout@master
-      - name: Set up Python 2.7
+      - name: Set up Python 3.7
         uses: actions/setup-python@v1
         with:
-          python-version: 2.7
+          python-version: 3.7
 
-      - name: Install twine
-        run: |
-            pip install twine
-
-      - name: Install wheel
-        run: |
-            pip install wheel
-
-      - name: Create a source distribution
-        run: |
-          python setup.py sdist
+      - name: Install Poetry
+        uses: dschep/[email protected]
 
-      - name: Create a wheel
-        run: |
-            python setup.py bdist_wheel
+      - name: Cache Poetry virtualenv
+        uses: actions/cache@v1
+        id: cache
+        with:
+          path: ~/.virtualenvs
+          key: poetry-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            poetry-${{ hashFiles('**/poetry.lock') }}
 
-      - name: Create a .pypirc
+      - name: Set Poetry config
         run: |
-            echo -e "[pypi]" >> ~/.pypirc
-            echo -e "username = __token__" >> ~/.pypirc
-            echo -e "password = ${{ secrets.PYPI_TOKEN }}" >> ~/.pypirc
-            echo -e "[testpypi]" >> ~/.pypirc
-            echo -e "username = __token__" >> ~/.pypirc
-            echo -e "password = ${{ secrets.TESTPYPI_TOKEN }}" >> ~/.pypirc
+          poetry config virtualenvs.in-project false
+          poetry config virtualenvs.path ~/.virtualenvs
 
-      - name: Publish to Test PyPI
-        if: github.event_name == 'release'
-        run: |
-          twine upload --skip-existing -r testpypi dist/*
+      - name: Install Dependencies
+        run: poetry install
+        if: steps.cache.outputs.cache-hit != 'true'
 
       - name: Publish to PyPI
         if: github.event_name == 'release'
         run: |
-          twine upload -r pypi dist/*
+          poetry publish -u __token__ -p ${{ secrets.PYPI_TOKEN }} --build

Dockerfile

@@ -0,0 +1,17 @@
+FROM redislabs/redisearch:edge as builder
+
+RUN apt update && apt install -y python3 python3-pip
+ADD . /build
+WORKDIR /build
+RUN pip3 install poetry
+RUN poetry config virtualenvs.create false
+RUN poetry build
+
+### clean docker stage
+FROM redislabs/redisearch:edge as runner
+
+RUN apt update && apt install -y python3 python3-pip git
+RUN rm -rf /var/cache/apt/
+
+COPY --from=builder /build/dist/redisearch*.tar.gz /tmp/
+RUN pip3 install /tmp/redisearch*.tar.gz

README.md

@@ -3,7 +3,7 @@
 [![CircleCI](https://circleci.com/gh/RediSearch/redisearch-py/tree/master.svg?style=svg)](https://circleci.com/gh/RediSearch/redisearch-py/tree/master)
 [![GitHub issues](https://img.shields.io/github/release/RediSearch/redisearch-py.svg)](https://github.com/RediSearch/redisearch-py/releases/latest)
 [![Codecov](https://codecov.io/gh/RediSearch/redisearch-py/branch/master/graph/badge.svg)](https://codecov.io/gh/RediSearch/redisearch-py)
-[![Known Vulnerabilities](https://snyk.io/test/github/RediSearch/redisearch-py/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/RediSearch/redisearch-py?targetFile=requirements.txt)
+[![Known Vulnerabilities](https://snyk.io/test/github/RediSearch/redisearch-py/badge.svg?targetFile=pyproject.toml)](https://snyk.io/test/github/RediSearch/redisearch-py?targetFile=pyproject.toml)
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/RediSearch/redisearch-py.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RediSearch/redisearch-py/alerts/)
 
 # RediSearch Python Client
@@ -394,6 +394,15 @@ req = AggregateRequest('*').group_by(
 $ pip install redisearch
 ```
 
+## Developing
+
+1. Create a virtualenv to manage your python dependencies, and ensure it's active.
+   ```virtualenv -v venv```
+2. Install [pypoetry](https://python-poetry.org/) to manage your dependencies.
+   ```pip install --user poetry```
+3. Install dependencies.
+   ```poetry install```
+
 ## Testing
 
 Testing can easily be performed using using Docker.