Skip to content

Dependencies: Update to cratedb-toolkit 0.0.33 #937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2025
Merged

Dependencies: Update to cratedb-toolkit 0.0.33 #937

merged 1 commit into from
May 13, 2025

Conversation

amotl
Copy link
Member

@amotl amotl commented May 12, 2025

Renamed CLI option --cratedb-sqlalchemy-url to --cluster-url
and environment variable CRATEDB_SQLALCHEMY_URL to CRATEDB_CLUSTER_URL.

Copy link

coderabbitai bot commented May 12, 2025

Walkthrough

The changes update the minimum required version of the cratedb-toolkit package (and its extras) to 0.0.33 across multiple requirements.txt and requirements-dev.txt files in various subprojects. Additionally, an environment variable in a README file was renamed from CRATEDB_SQLALCHEMY_URL to CRATEDB_CLUSTER_URL. Test commands were also updated to use the new environment variable name.

Changes

File(s) Change Summary
application/cratedb-toolkit/requirements.txt Updated cratedb-toolkit[influxdb,mongodb] version requirement from >=0.0.30 to >=0.0.33.
framework/mcp/requirements.txt
topic/machine-learning/llama-index/requirements-dev.txt
Changed cratedb-toolkit from unspecified version to >=0.0.33.
framework/mcp/README.md Changed environment variable from CRATEDB_SQLALCHEMY_URL to CRATEDB_CLUSTER_URL.
testing/testcontainers/python-pytest/requirements.txt
testing/testcontainers/python-unittest/requirements.txt
Updated cratedb-toolkit[testing] version requirement from >=0.0.29 to >=0.0.33.
topic/machine-learning/automl/requirements-dev.txt
topic/machine-learning/mlops-mlflow/requirements-dev.txt
Updated cratedb-toolkit[io] version requirement from >=0.0.29 to >=0.0.33.
topic/machine-learning/llm-langchain/requirements-dev.txt Changed cratedb-toolkit[io] from unspecified version to >=0.0.33.
topic/timeseries/requirements.txt Updated cratedb-toolkit[datasets] version requirement from >=0.0.30 to >=0.0.33.
application/cratedb-toolkit/test_io.py Updated test commands to replace --cratedb-sqlalchemy-url with --cluster-url.

Suggested reviewers

  • kneth
  • surister

Poem

🐰
Hopping through requirements, I nudge the toolkit’s age,
From twenty-nine and thirty, to thirty-three I engage.
A cluster URL now leads the way,
In README fields where bunnies play.
With every version hop and line,
The garden’s dependencies align!
🌱✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd48e1b and 4392e82.

📒 Files selected for processing (11)
  • application/cratedb-toolkit/requirements.txt (1 hunks)
  • application/cratedb-toolkit/test_io.py (2 hunks)
  • framework/mcp/README.md (1 hunks)
  • framework/mcp/requirements.txt (1 hunks)
  • testing/testcontainers/python-pytest/requirements.txt (1 hunks)
  • testing/testcontainers/python-unittest/requirements.txt (1 hunks)
  • topic/machine-learning/automl/requirements-dev.txt (1 hunks)
  • topic/machine-learning/llama-index/requirements-dev.txt (1 hunks)
  • topic/machine-learning/llm-langchain/requirements-dev.txt (1 hunks)
  • topic/machine-learning/mlops-mlflow/requirements-dev.txt (1 hunks)
  • topic/timeseries/requirements.txt (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • framework/mcp/README.md
🚧 Files skipped from review as they are similar to previous changes (10)
  • framework/mcp/requirements.txt
  • topic/timeseries/requirements.txt
  • topic/machine-learning/llama-index/requirements-dev.txt
  • testing/testcontainers/python-pytest/requirements.txt
  • topic/machine-learning/llm-langchain/requirements-dev.txt
  • testing/testcontainers/python-unittest/requirements.txt
  • topic/machine-learning/mlops-mlflow/requirements-dev.txt
  • application/cratedb-toolkit/requirements.txt
  • topic/machine-learning/automl/requirements-dev.txt
  • application/cratedb-toolkit/test_io.py
⏰ Context from checks skipped due to timeout of 90000ms (14)
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.13 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.12 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.13 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.12 CrateDB: nightly on ubuntu-22.04
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.9 CrateDB: nightly on ubuntu-22.04
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5af7e07 and 614c69d.

📒 Files selected for processing (10)
  • application/cratedb-toolkit/requirements.txt (1 hunks)
  • framework/mcp/README.md (1 hunks)
  • framework/mcp/requirements.txt (1 hunks)
  • testing/testcontainers/python-pytest/requirements.txt (1 hunks)
  • testing/testcontainers/python-unittest/requirements.txt (1 hunks)
  • topic/machine-learning/automl/requirements-dev.txt (1 hunks)
  • topic/machine-learning/llama-index/requirements-dev.txt (1 hunks)
  • topic/machine-learning/llm-langchain/requirements-dev.txt (1 hunks)
  • topic/machine-learning/mlops-mlflow/requirements-dev.txt (1 hunks)
  • topic/timeseries/requirements.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: Python: 3.13 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.12 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.13 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.11 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
  • GitHub Check: Python: 3.10 CrateDB: nightly on ubuntu-latest
🔇 Additional comments (6)
testing/testcontainers/python-unittest/requirements.txt (1)

3-3: Bump cratedb-toolkit testing dependency to 0.0.33
Updated cratedb-toolkit[testing] from >=0.0.29 to >=0.0.33 to stay in sync with other requirement files.

topic/machine-learning/mlops-mlflow/requirements-dev.txt (1)

2-2: Update cratedb-toolkit[io] version to 0.0.33
The minimum version for cratedb-toolkit[io] has been raised to >=0.0.33, matching the coordinated bump across the repo.

application/cratedb-toolkit/requirements.txt (1)

2-2: Align influxdb,mongodb extras version with 0.0.33
The cratedb-toolkit[influxdb,mongodb] requirement is now >=0.0.33, consistent with other components.

topic/machine-learning/llama-index/requirements-dev.txt (1)

1-1: Require cratedb-toolkit >=0.0.33
Added a minimum version constraint for cratedb-toolkit to ensure feature compatibility.

framework/mcp/README.md (1)

126-126: Rename environment variable to CRATEDB_CLUSTER_URL
Updated the shell export command to use CRATEDB_CLUSTER_URL instead of CRATEDB_SQLALCHEMY_URL. Please verify there are no leftover references to the old variable name in docs or scripts.

framework/mcp/requirements.txt (1)

2-2:

✅ Verification successful

Validate cratedb-toolkit version bump to 0.0.33
The entry cratedb-toolkit>=0.0.33 correctly enforces the minimum version. Ensure that no breaking changes were introduced in 0.0.33 and that this constraint works with the updated environment variable (CRATEDB_CLUSTER_URL) in the associated README.

Verify publication using:


🏁 Script executed:

#!/bin/bash
curl -s https://pypi.org/pypi/cratedb-toolkit/json | jq '.releases | has("0.0.33")'

Length of output: 90


cratedb-toolkit 0.0.33 publication verified
Version 0.0.33 is published on PyPI and the constraint cratedb-toolkit>=0.0.33 is correct. Please run your integration tests (especially around the updated CRATEDB_CLUSTER_URL in the README) to catch any breaking changes before merging.

@@ -1,5 +1,5 @@
# Real.
cratedb-toolkit[io]>=0.0.29
cratedb-toolkit[io]>=0.0.33
Copy link

@coderabbitai coderabbitai bot May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Validate cratedb-toolkit version bump to 0.0.33
The line cratedb-toolkit[io]>=0.0.33 is updated as intended. Ensure that 0.0.33 is available with the [io] extra and that there are no incompatible changes.

Use the following to verify release presence:


🏁 Script executed:

#!/bin/bash
curl -s https://pypi.org/pypi/cratedb-toolkit/json | jq '.releases | has("0.0.33")'

Length of output: 90


🏁 Script executed:

#!/bin/bash
curl -s https://pypi.org/pypi/cratedb-toolkit/json | jq '.info.extras'

Length of output: 75


Undefined [io] extra in cratedb-toolkit requirement
PyPI metadata for cratedb-toolkit shows info.extras is null, so the [io] extra isn’t defined and will cause install failures. Please remove or correct this extra.

• File: topic/machine-learning/automl/requirements-dev.txt, line 2

-cratedb-toolkit[io]>=0.0.33
+cratedb-toolkit>=0.0.33
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cratedb-toolkit[io]>=0.0.33
-cratedb-toolkit[io]>=0.0.33
+cratedb-toolkit>=0.0.33
🤖 Prompt for AI Agents (early access)
In topic/machine-learning/automl/requirements-dev.txt at line 2, the requirement
specifies cratedb-toolkit[io]>=0.0.33, but the [io] extra is not defined in the
package metadata and will cause installation failures. Remove the [io] extra
from the requirement line so it reads cratedb-toolkit>=0.0.33 to fix the issue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai: We do not see any information in info.extras at all, see:

curl -s https://pypi.org/pypi/cratedb-toolkit/0.0.33/json | jq '.info.extras'
null

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if we can find information about extras in the package metadata
python -m pip install cratedb-toolkit==0.0.33 --dry-run -v

# Let's look at other places in this repo that use cratedb-toolkit with extras
rg "cratedb-toolkit\[" -A 1 -B 1 --no-filename

# Let's look at what's currently installed if the package is already in use
python -c "try:
    import pkg_resources
    dist = pkg_resources.get_distribution('cratedb-toolkit')
    print(f'Version: {dist.version}')
    print(f'Extras: {dist._DistInfoDistribution__dep_map}')
except Exception as ex:
    print(f'Error: {ex}')
"

Length of output: 18374


🏁 Script executed:

#!/bin/bash
# Let's look for the cratedb-toolkit repository to understand extras
echo "Searching for the cratedb-toolkit repository..."
curl -s https://api.github.com/search/repositories?q=cratedb-toolkit | jq '.items[0].html_url'

# Let's also examine how the package is set up to understand extras configuration
echo "Looking for setup.py in the repository..."
curl -s https://api.github.com/search/code?q=setup.py+repo:crate-workbench/cratedb-toolkit | jq '.items[].html_url'

# Check if the package has extras_require in its setup configuration
echo "Examining setup.py content to see extras_require..."
curl -s https://raw.githubusercontent.com/crate-workbench/cratedb-toolkit/main/setup.py | grep -A 30 "extras_require"

Length of output: 749


🏁 Script executed:

#!/bin/bash
# Let's look for the cratedb-toolkit repository in the right location
echo "Searching for the correct cratedb-toolkit repository..."
curl -s https://raw.githubusercontent.com/crate/cratedb-toolkit/main/setup.py | grep -A 30 "extras_require"

# Let's also check pyproject.toml as modern Python packages often use it instead of setup.py
echo "Checking pyproject.toml for extras_require..."
curl -s https://raw.githubusercontent.com/crate/cratedb-toolkit/main/pyproject.toml | grep -A 30 "extras"

# Let's analyze the actual package content to understand the extras
echo "Let's check if the package actually installs with extras..."
python -m pip install cratedb-toolkit[io]==0.0.33 --dry-run

Length of output: 17963


@amotl You're absolutely right to question this finding. While the PyPI metadata doesn't explicitly list the extras in the .info.extras field, I can confirm that the [io] extra is indeed properly supported by the package.

I ran a dry-run installation of cratedb-toolkit[io]==0.0.33 and it correctly resolved the extra dependencies. When using the [io] extra, it adds several IO-related packages like:

  • cr8
  • dask[dataframe]
  • fsspec[http,s3]
  • pandas
  • polars
  • sqlalchemy
  • universal-pathlib

This confirms that despite not being visible in the PyPI metadata, the extras functionality works correctly. This is sometimes seen with Python packages where the extras are defined in setup.py/pyproject.toml but not properly exposed through the PyPI API.

The requirement cratedb-toolkit[io]>=0.0.33 is valid and should work fine as is. No changes are needed to your PR.

Copy link
Member Author

@amotl amotl May 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai: You made me curious about this statement:

This confirms that despite not being visible in the PyPI metadata, the extras functionality works correctly. This is sometimes seen with Python packages where the extras are defined in setup.py/pyproject.toml but not properly exposed through the PyPI API.

Is something not right with the cratedb-toolkit package, or can it be improved?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No description provided.

Renamed CLI option --cratedb-sqlalchemy-url to --cluster-url
and environment variable CRATEDB_SQLALCHEMY_URL to CRATEDB_CLUSTER_URL.
@amotl amotl marked this pull request as ready for review May 13, 2025 06:38
@amotl amotl merged commit ae4330f into main May 13, 2025
17 of 19 checks passed
@amotl amotl deleted the ctk-0.0.33 branch May 13, 2025 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant