PyPI Infrastructure (#38)

PyPI release infrastructure

Author: Sam Partee

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: deploy-release
+
+on:
+  pull_request:
+    types: [closed]
+    branches: [master]
+
+jobs:
+  build_release:
+    if: |
+        ${{ github.event.pull_request.merged == true }}
+        && ${{ contains(github.event.pull_request.labels.*.name, 'release') }}
+    name: Build Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: check-version
+        run: echo ::set_output name=version::$(python setup.py --version)
+
+      - name: create python package
+        run: python setup.py bdist_wheel
+
+      - name: Create Release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "dist/*"
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: false
+          generateReleaseNotes: true
+          tag: v${{ steps.check-version.outputs.version }}
+          commit: master
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI }}
+          repository_url: https://test.pypi.org/legacy/

redisvl/__init__.py

@@ -0,0 +1,5 @@
+
+
+from redisvl.version import __version__
+
+all = ["__version__"]

redisvl/cli/index.py

@@ -9,8 +9,7 @@
 from redisvl.utils.connection import get_redis_connection
 from redisvl.utils.utils import convert_bytes
 
-logger = get_logger(__name__)
-
+logger = get_logger("[RedisVL]")
 
 class Index:
     usage = "\n".join(

redisvl/cli/log.py

@@ -6,10 +6,9 @@
 # constants for logging
 coloredlogs.DEFAULT_DATE_FORMAT = "%H:%M:%S"
 coloredlogs.DEFAULT_LOG_FORMAT = (
-    "%(asctime)s %(hostname)s %(name)s[%(process)d] %(levelname)s %(message)s"
+    "%(asctime)s %(name)s %(levelname)s   %(message)s"
 )
 
-
 def get_logger(name, log_level="info", fmt=None):
     """Return a logger instance"""
 

redisvl/cli/main.py

@@ -2,6 +2,7 @@
 import sys
 
 from redisvl.cli.index import Index
+from redisvl.cli.version import Version
 from redisvl.cli.log import get_logger
 
 logger = get_logger(__name__)
@@ -12,6 +13,7 @@ def _usage():
         "rvl <command> [<args>]\n",
         "Commands:",
         "\tindex       Index manipulation (create, delete, etc.)",
+        "\tversion     Obtain the version of RedisVL",
     ]
     return "\n".join(usage) + "\n"
 
@@ -37,3 +39,7 @@ def __init__(self):
     def index(self):
         Index()
         exit(0)
+
+    def version(self):
+        Version()
+        exit(0)

redisvl/cli/version.py

@@ -0,0 +1,31 @@
+import sys
+import argparse
+from argparse import Namespace
+
+from redisvl import __version__
+from redisvl.cli.log import get_logger
+logger = get_logger("[RedisVL]")
+
+
+class Version:
+    usage = "\n".join(
+        [
+            "rvl version [<args>]\n",
+            "\n",
+        ]
+    )
+
+    def __init__(self):
+        parser = argparse.ArgumentParser(usage=self.usage)
+        parser.add_argument(
+            "-s", "--short", help="Print only the version number", action="store_true"
+        )
+
+        args = parser.parse_args(sys.argv[2:])
+        self.version(args)
+
+    def version(self, args: Namespace):
+        if args.short:
+            print(__version__)
+        else:
+            logger.info(f"RedisVL version {__version__}")

redisvl/version.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

setup.cfg

@@ -0,0 +1,22 @@
+[metadata]
+name = redisvl
+description = Python client library and CLI for using Redis as a vector database
+long_description = file: README.md
+long_description_content_type=text/markdown
+
+url = https://github.com/RedisVentures/redisvl
+project_urls =
+    Source = https://github.com/RedisVentures/redisvl
+    Documentation = https://www.redisvl.com
+
+author = Redis Inc.
+contact = Sam Partee
+contact_email = sam.partee@redis.com
+license = MIT
+keywords = ai, redis, redis-client, vector-database, vector-search
+classifiers =
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    License :: OSI Approved :: MIT License

setup.py

@@ -22,13 +22,12 @@ def read_dev_requirements():
 
 setup(
     name="redisvl",
-    description="Vector loading utility for Redis vector search",
-    license="BSD-3-Clause",
-    version="0.1.0",
+    version="0.0.1",
     python_requires=">=3.7",
     install_requires=read_requirements(),
     extras_require=extras_require,
     packages=find_packages(),
+    package_data = {"redisvl": ["requirements.txt", "requirements-dev.txt"]},
     zip_safe=False,
     entry_points={
         "console_scripts": [