BREAKING: New ILP/HTTP and Sender.from_conf API (#59)

Author: amunra

.bumpversion.cfg

@@ -24,5 +24,5 @@ search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 
 [bumpversion:file:src/questdb/ingress.pyx]
-search = 'v{current_version}'
-replace = 'v{new_version}'
+search = VERSION = '{current_version}'
+replace = VERSION = '{new_version}'

README.rst

@@ -21,13 +21,14 @@ The latest version of the library is 1.2.0.
 
 ::
 
-    python3 -m pip install questdb
+    python3 -m pip install -U questdb
 
 .. code-block:: python
 
     from questdb.ingress import Sender, TimestampNanos
 
-    with Sender('localhost', 9009) as sender:
+    conf = f'http::addr=localhost:9000;'
+    with Sender.from_conf(conf) as sender:
         sender.row(
             'sensors',
             symbols={'id': 'toronto1'},
@@ -48,10 +49,25 @@ You can also send Pandas dataframes:
         'humidity': [0.5, 0.6],
         'timestamp': pd.to_datetime(['2021-01-01', '2021-01-02'])})
 
-    with Sender('localhost', 9009) as sender:
+    conf = f'http::addr=localhost:9000;'
+    with Sender.from_conf(conf) as sender:
         sender.dataframe(df, table_name='sensors', at='timestamp')
 
 
+To connect via TCP, set the
+`configuration string <https://py-questdb-client.readthedocs.io/en/latest/conf.html>`_ to:
+
+.. code-block:: python
+
+    conf = f'tcp::addr=localhost:9009;'
+    with Sender.from_conf(conf) as sender:
+        ...
+
+
+You can continue by reading the
+`Sending Data Over ILP <https://py-questdb-client.readthedocs.io/en/latest/sender.html>`_
+guide.
+
 Docs
 ====
 

c-questdb-client

@@ -3,19 +3,28 @@
 import shlex
 import textwrap
 import platform
+import argparse
 
 
+arg_parser = argparse.ArgumentParser(
+    prog='pip_install_deps.py',
+    description='installs dependencies'
+)
+
+arg_parser.add_argument('--pandas-version')
+
 class UnsupportedDependency(Exception):
     pass
 
 
-def pip_install(package):
+def pip_install(package, version=None):
     args = [
         sys.executable,
         '-m', 'pip', 'install',
         '--upgrade',
         '--only-binary', ':all:',
-        package]
+        package if version is None else f'{package}=={version}'
+    ]
     args_s = ' '.join(shlex.quote(arg) for arg in args)
     sys.stderr.write(args_s + '\n')
     res = subprocess.run(
@@ -35,9 +44,9 @@ def pip_install(package):
         sys.exit(res.returncode)
 
 
-def try_pip_install(package):
+def try_pip_install(package, version=None):
     try:
-        pip_install(package)
+        pip_install(package, version)
     except UnsupportedDependency as e:
         msg = textwrap.indent(str(e), ' ' * 8)
         sys.stderr.write(f'    Ignored unsatisfiable dependency:\n{msg}\n')
@@ -52,12 +61,18 @@ def ensure_timezone():
         pip_install('pytz')
 
 
-def main():
+def main(args):
     ensure_timezone()
     pip_install('pip')
     pip_install('setuptools')
     try_pip_install('fastparquet>=2023.10.1')
-    try_pip_install('pandas')
+
+    print(f"DEBUG: {args}, pandas: {args.pandas_version}")
+
+    if args.pandas_version is not None and args.pandas_version != '':
+        try_pip_install('pandas', args.pandas_version)
+    else:
+        try_pip_install('pandas')
     try_pip_install('numpy')
     try_pip_install('pyarrow')
 
@@ -80,4 +95,5 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    args = arg_parser.parse_args()
+    main(args)

ci/pip_install_deps.py

@@ -11,6 +11,14 @@ stages:
             linux:
               imageName: "ubuntu-latest"
               poolName: "Azure Pipelines"
+            linux-old-pandas:
+              imageName: "ubuntu-latest"
+              poolName: "Azure Pipelines"
+              pandasVersion: "2.1.4"
+            linux-qdb-master:
+              imageName: "ubuntu-latest"
+              poolName: "Azure Pipelines"
+              vsQuestDbMaster: true
             mac:
               imageName: "macos-latest"
               poolName: "Azure Pipelines"
@@ -27,14 +35,36 @@ stages:
             lfs: false
             submodules: true
           - task: UsePythonVersion@0
-          - script: python3 --version
           - script: |
+              python3 --version
               python3 -m pip install cython
-              python3 ci/pip_install_deps.py
-            displayName: Installing Python dependencies
+            displayName: "Install cython"
+          - script: python3 ci/pip_install_deps.py
+            displayName: "Install pandas latest"
+            condition: eq(variables.pandasVersion, '')
+          - script:  python3 ci/pip_install_deps.py --pandas-version==$(pandasVersion)
+            displayName: "Install pandas older"
+            condition: ne(variables.pandasVersion, '')
           - script: python3 proj.py build
             displayName: "Build"
+          - script: |
+              git clone --depth 1 https://github.com/questdb/questdb.git
+            displayName: git clone questdb
+            condition: eq(variables.vsQuestDbMaster, true)
+          - task: Maven@3
+            displayName: "Compile QuestDB"
+            inputs:
+              mavenPOMFile: 'questdb/pom.xml'
+              jdkVersionOption: '1.11'
+              options: "-DskipTests -Pbuild-web-console"
+            condition: eq(variables.vsQuestDbMaster, true)
+          - script: python3 proj.py test 1
+            displayName: "Test vs released"
+            env:
+              JAVA_HOME: $(JAVA_HOME_11_X64)
           - script: python3 proj.py test 1
-            displayName: "Test"
+            displayName: "Test vs master"
             env:
               JAVA_HOME: $(JAVA_HOME_11_X64)
+              QDB_REPO_PATH: './questdb'
+            condition: eq(variables.vsQuestDbMaster, true)

ci/run_tests_pipeline.yaml

@@ -1,6 +1,9 @@
-============
-Contributing
-============
+=========
+Community
+=========
+
+Contributions
+=============
 
 Contributions are welcome, and they are greatly appreciated! Every
 little bit helps, and credit will always be given.
@@ -26,6 +29,21 @@ Development
 To get set up for local development follow the
 `development notes <https://github.com/questdb/py-questdb-client/blob/main/DEV_NOTES.rst>`_. 
 
+Chat to us
+==========
+
 If you want to engage with us to discuss your changes or if you need help,
 there's a `#contributors` channel on our `slack <http://slack.questdb.io>`_ server
-just for that.
+just for that.
+
+Asking for help
+===============
+
+The best thing to do is to
+`ask on Stack Overflow <https://stackoverflow.com/questions/ask?tags=questdb&tags=py-questdb-client>`_.
+We monitor the `questdb` tag and will get back to you.
+
+Stack overflow helps us to keep track of the questions and answers, and it helps
+other users who might have the same question.
+
+Alternatively, you can ask on our `slack <http://slack.questdb.io>`_ server.