Update from latest staging. preparing for new release (#83)

Co-authored-by: Jeff Lin <42981468+jleifnf@users.noreply.github.com>
Co-authored-by: Andrew Chambers <andrew@pingthings.io>
Co-authored-by: andrewchambers <andrewchamberss@gmail.com>
Co-authored-by: Alexander Young <alexander.young@pingthings.io>

Author: 4 people

.github/workflows/pre-commit.yaml

@@ -18,19 +18,19 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         fetch-depth: 0 # get full git history
-    - uses: actions/setup-python@v3
+    - uses: actions/setup-python@v5
       with:
         cache: 'pip'
     - name: Install pre-commit
       run: |
         pip install pre-commit
     - name: Get changed files
       id: changed-files
-      uses: tj-actions/changed-files@v41
+      uses: tj-actions/changed-files@v43
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
     - name: Run pre-commit

.github/workflows/release.yaml

@@ -6,40 +6,41 @@ on:
       - synchronize
   push:
     tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+*'
+      - "v[0-9]+.[0-9]+.[0-9]+*"
 
 jobs:
-
   test-suite:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10']
+        python-version: [3.7, 3.8, 3.9, "3.10", "3.11"]
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }} ${{ matrix.os }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r tests/requirements.txt
-    - name: Test with pytest
-      run: |
-        pytest
-
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }} ${{ matrix.os }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r tests/requirements.txt
+      - name: Test with pytest
+        run: |
+          pytest --cov-report= --cov=btrdb # suppress coverage report here
+      - name: Coverage Report
+        run: |
+          coverage report -m
 
   release:
     needs:
       - test-suite
     if: startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
@@ -51,28 +52,27 @@ jobs:
           draft: false
           prerelease: false
 
-
   deploy:
     needs:
       - release
     if: startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.8'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel build
-    - name: Build and publish
-      run: |
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel build
+      - name: Build and publish
+        run: |
           python -m build --sdist --wheel --outdir dist/ .
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_DEPLOYMENT_TOKEN }}
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_DEPLOYMENT_TOKEN }}

.pre-commit-config.yaml

@@ -1,26 +1,26 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v4.5.0
   hooks:
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
       exclude: ^(setup.cfg|btrdb/grpcinterface)
 - repo: https://github.com/psf/black
-  rev: 23.3.0
+  rev: 24.3.0
   hooks:
     - id: black-jupyter
       args: [--line-length=88]
       exclude: btrdb/grpcinterface/.*\.py
 - repo: https://github.com/pycqa/isort
-  rev: 5.11.5
+  rev: 5.13.2
   hooks:
     - id: isort
       name: isort (python)
       args: [--profile=black, --line-length=88]
       exclude: btrdb/grpcinterface/.*\.py
 - repo: https://github.com/PyCQA/flake8
-  rev: 6.0.0
+  rev: 7.0.0
   hooks:
   - id: flake8
     args: [--config=setup.cfg]

CHANGELOG.md

@@ -1,4 +1,39 @@
 # Changelog
+
+## 5.32.0 - YYYY-MM-DD
+
+### What's Changed
+- Initial docstring overhaul and a new test for better documentation and test coverage. by @JustinGilmer in #82
+- Test new join functionality for improved data loading for windowed queries. by @JustinGilmer in #80
+- Improve `arrow_to_dataframe` function for handling large amounts of columns, enhancing performance and usability. by @Jefflinf in #73
+- Expand testing to include Python 3.11, ensuring compatibility and stability. by @JustinGilmer in #74
+- Update exception handling to better support `RpcErrors`, improving error management and debugging. by @JustinGilmer in #72
+- Introduce an option for specifying the schema of the returned data, allowing for more flexibility in data handling. by @TODO in #51
+- Remove non-required dependencies and migrate to 'data' optional dependency for a lighter package and easier installation. by @JustinGilmer in #71
+- New method to get first and last timestamps from `aligned_windows`, enhancing data analysis capabilities. by @Jefflinf in #70
+- Add `to_timedelta` method for `pointwidth` class, providing more options for time-based data manipulation. by @Jefflinf in #69
+
+### Fixed
+- Fix `NoneType` error for `earliest/latest` for empty streams, ensuring reliability and error handling. by @Jefflinf in #64
+- Correct integration tests where the time column is not automatically set as the index, improving test accuracy and reliability. by @JustinGilmer in #56
+
+### Deprecated
+- FutureWarning for `streams_in_collection` to return `StreamSet` in the future, preparing users for upcoming API changes. by @Jefflinf in #60
+
+**Full Changelog**: [GitHub compare view](https://github.com/PingThingsIO/btrdb-python/compare/v5.31.0...v5.32.0)
+
+
+## 5.31.0
+## What's Changed
+* Release v5.30.2 by @youngale-pingthings in https://github.com/PingThingsIO/btrdb-python/pull/42
+* Have release script update pyproject.toml file by @youngale-pingthings in https://github.com/PingThingsIO/btrdb-python/pull/48
+* Provide option to sort the arrow tables by @justinGilmer in https://github.com/PingThingsIO/btrdb-python/pull/47
+* [sc-25841] Remove 4MB limit for gRPC message payloads by @justinGilmer in https://github.com/PingThingsIO/btrdb-python/pull/49
+* Update documentation for arrow methods by @justinGilmer in https://github.com/PingThingsIO/btrdb-python/pull/50
+* Update from staging by @justinGilmer in https://github.com/PingThingsIO/btrdb-python/pull/54
+* Sort tables by time by default for any `pyarrow` tables. by @justinGilmer in
+* Fix deprecation warnings for pip installations. by @jleifnf in
+
 ## 5.30.2
 ### What's Changed
 * Update readthedocs to new yaml for testing. by @justinGilmer in https://github.com/PingThingsIO/btrdb-python/pull/40

btrdb/__init__.py

@@ -52,18 +52,18 @@ def connect(conn_str=None, apikey=None, profile=None, shareable=False):
     Parameters
     ----------
     conn_str: str, default=None
-        The address and port of the cluster to connect to, e.g. `192.168.1.1:4411`.
-        If set to None, will look in the environment variable `$BTRDB_ENDPOINTS`
+        The address and port of the cluster to connect to, e.g. ``192.168.1.1:4411``.
+        If set to None, will look in the environment variable ``$BTRDB_ENDPOINTS``
         (recommended).
     apikey: str, default=None
         The API key used to authenticate requests (optional). If None, the key
-        is looked up from the environment variable `$BTRDB_API_KEY`.
+        is looked up from the environment variable ``$BTRDB_API_KEY``.
     profile: str, default=None
         The name of a profile containing the required connection information as
         found in the user's predictive grid credentials file
-        `~/.predictivegrid/credentials.yaml`.
+        ``~/.predictivegrid/credentials.yaml``.
     shareable: bool, default=False
-        Whether or not the connection can be "shared" in a distributed setting such
+        Whether the connection can be "shared" in a distributed setting such
         as Ray workers. If set to True, the connection can be serialized and sent
         to other workers so that data can be retrieved in parallel; **however**, this
         is less secure because it is possible for other users of the Ray cluster to
@@ -74,6 +74,25 @@ def connect(conn_str=None, apikey=None, profile=None, shareable=False):
     db : BTrDB
         An instance of the BTrDB context to directly interact with the database.
 
+    Examples
+    --------
+    This example looks for the env variables: ``BTRDB_ENDPOINTS`` and ``BTRDB_API_KEY``.
+
+    >>> conn = btrdb.connect()
+    <btrdb.conn.BTrDB at 0x...>
+
+
+    Connect to the platform by looking for the relevant platform profile
+    in ``${HOME}/.predictivegrid/credentials.yaml`` if the file is present.
+
+    >>> conn = btrdb.connect(profile='test')
+    <btrdb.conn.BTrDB at 0x...>
+
+    If you provide incorrect credentials, you will get an error.
+
+    >>> conn = btrdb.connect(conn_str="192.168.1.1:4411", apikey="NONSENSICAL_API_KEY")
+
+
     """
     # do not allow user to provide both address and profile
     if conn_str and profile: