dremio-cli 1.11.0__tar.gz → 2.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. dremio_cli-2.1.0/.claude-plugin/marketplace.json +11 -0
  2. dremio_cli-2.1.0/.github/workflows/ci.yml +33 -0
  3. dremio_cli-2.1.0/.github/workflows/release.yml +59 -0
  4. dremio_cli-2.1.0/.gitignore +17 -0
  5. dremio_cli-2.1.0/.license-header.txt +13 -0
  6. dremio_cli-2.1.0/.pre-commit-config.yaml +15 -0
  7. dremio_cli-2.1.0/.python-version +1 -0
  8. dremio_cli-2.1.0/CODE_OF_CONDUCT.md +77 -0
  9. dremio_cli-2.1.0/CONTRIBUTING.md +98 -0
  10. dremio_cli-2.1.0/DISCOVERY_SERVICE_PLAN.md +381 -0
  11. dremio_cli-2.1.0/LICENSE +190 -0
  12. dremio_cli-2.1.0/PKG-INFO +414 -0
  13. dremio_cli-2.1.0/README.md +385 -0
  14. dremio_cli-2.1.0/SPIKE_NOTES.md +81 -0
  15. dremio_cli-2.1.0/TESTING.md +92 -0
  16. dremio_cli-2.1.0/plugins/dremio/.claude-plugin/plugin.json +16 -0
  17. dremio_cli-2.1.0/plugins/dremio/skills/audit-dataset-access/SKILL.md +143 -0
  18. dremio_cli-2.1.0/plugins/dremio/skills/document-dataset/SKILL.md +144 -0
  19. dremio_cli-2.1.0/plugins/dremio/skills/dremio/SKILL.md +136 -0
  20. dremio_cli-2.1.0/plugins/dremio/skills/dremio-dbt/SKILL.md +160 -0
  21. dremio_cli-2.1.0/plugins/dremio/skills/dremio-setup/SKILL.md +138 -0
  22. dremio_cli-2.1.0/plugins/dremio/skills/investigate-data-quality/SKILL.md +145 -0
  23. dremio_cli-2.1.0/plugins/dremio/skills/investigate-slow-query/SKILL.md +161 -0
  24. dremio_cli-2.1.0/plugins/dremio/skills/onboard-new-source/SKILL.md +183 -0
  25. dremio_cli-2.1.0/pyproject.toml +97 -0
  26. dremio_cli-2.1.0/scripts/parse_jssdk.py +435 -0
  27. dremio_cli-2.1.0/scripts/validate_api_coverage.py +237 -0
  28. dremio_cli-2.1.0/src/drs/__init__.py +20 -0
  29. dremio_cli-2.1.0/src/drs/_version.py +24 -0
  30. dremio_cli-2.1.0/src/drs/auth.py +86 -0
  31. dremio_cli-2.1.0/src/drs/chat_render.py +314 -0
  32. dremio_cli-2.1.0/src/drs/cli.py +204 -0
  33. dremio_cli-2.1.0/src/drs/client.py +417 -0
  34. dremio_cli-2.1.0/src/drs/commands/__init__.py +15 -0
  35. dremio_cli-2.1.0/src/drs/commands/chat.py +703 -0
  36. dremio_cli-2.1.0/src/drs/commands/engine.py +204 -0
  37. dremio_cli-2.1.0/src/drs/commands/folder.py +184 -0
  38. dremio_cli-2.1.0/src/drs/commands/grant.py +143 -0
  39. dremio_cli-2.1.0/src/drs/commands/job.py +127 -0
  40. dremio_cli-2.1.0/src/drs/commands/project.py +164 -0
  41. dremio_cli-2.1.0/src/drs/commands/query.py +232 -0
  42. dremio_cli-2.1.0/src/drs/commands/reflection.py +225 -0
  43. dremio_cli-2.1.0/src/drs/commands/role.py +167 -0
  44. dremio_cli-2.1.0/src/drs/commands/schema.py +134 -0
  45. dremio_cli-2.1.0/src/drs/commands/setup.py +249 -0
  46. dremio_cli-2.1.0/src/drs/commands/tag.py +137 -0
  47. dremio_cli-2.1.0/src/drs/commands/user.py +221 -0
  48. dremio_cli-2.1.0/src/drs/commands/wiki.py +137 -0
  49. dremio_cli-2.1.0/src/drs/introspect.py +767 -0
  50. dremio_cli-2.1.0/src/drs/output.py +123 -0
  51. dremio_cli-2.1.0/src/drs/sse.py +78 -0
  52. dremio_cli-2.1.0/src/drs/utils.py +227 -0
  53. dremio_cli-2.1.0/tests/__init__.py +15 -0
  54. dremio_cli-2.1.0/tests/conftest.py +45 -0
  55. dremio_cli-2.1.0/tests/test_auth.py +164 -0
  56. dremio_cli-2.1.0/tests/test_client.py +141 -0
  57. dremio_cli-2.1.0/tests/test_client_retry.py +156 -0
  58. dremio_cli-2.1.0/tests/test_commands/__init__.py +15 -0
  59. dremio_cli-2.1.0/tests/test_commands/test_chat.py +115 -0
  60. dremio_cli-2.1.0/tests/test_commands/test_engine.py +87 -0
  61. dremio_cli-2.1.0/tests/test_commands/test_folder.py +84 -0
  62. dremio_cli-2.1.0/tests/test_commands/test_grant.py +47 -0
  63. dremio_cli-2.1.0/tests/test_commands/test_project.py +64 -0
  64. dremio_cli-2.1.0/tests/test_commands/test_query.py +224 -0
  65. dremio_cli-2.1.0/tests/test_commands/test_reflection.py +124 -0
  66. dremio_cli-2.1.0/tests/test_commands/test_role.py +76 -0
  67. dremio_cli-2.1.0/tests/test_commands/test_setup.py +273 -0
  68. dremio_cli-2.1.0/tests/test_commands/test_tag.py +52 -0
  69. dremio_cli-2.1.0/tests/test_commands/test_user.py +81 -0
  70. dremio_cli-2.1.0/tests/test_commands/test_wiki.py +53 -0
  71. dremio_cli-2.1.0/tests/test_output.py +78 -0
  72. dremio_cli-2.1.0/tests/test_sse.py +130 -0
  73. dremio_cli-2.1.0/tests/test_utils.py +147 -0
  74. dremio_cli-2.1.0/uv.lock +603 -0
  75. dremio_cli-1.11.0/LICENSE +0 -21
  76. dremio_cli-1.11.0/MANIFEST.in +0 -11
  77. dremio_cli-1.11.0/PKG-INFO +0 -290
  78. dremio_cli-1.11.0/README.md +0 -237
  79. dremio_cli-1.11.0/completions/dremio-completion.bash +0 -89
  80. dremio_cli-1.11.0/completions/dremio-completion.zsh +0 -89
  81. dremio_cli-1.11.0/docs/README.md +0 -221
  82. dremio_cli-1.11.0/docs/advanced-features.md +0 -293
  83. dremio_cli-1.11.0/docs/catalog.md +0 -334
  84. dremio_cli-1.11.0/docs/completion.md +0 -37
  85. dremio_cli-1.11.0/docs/dac.md +0 -128
  86. dremio_cli-1.11.0/docs/dac_governance.md +0 -88
  87. dremio_cli-1.11.0/docs/dac_reflections.md +0 -63
  88. dremio_cli-1.11.0/docs/dac_sources.md +0 -80
  89. dremio_cli-1.11.0/docs/dac_tables.md +0 -78
  90. dremio_cli-1.11.0/docs/dac_validations.md +0 -54
  91. dremio_cli-1.11.0/docs/favorites.md +0 -63
  92. dremio_cli-1.11.0/docs/grants.md +0 -476
  93. dremio_cli-1.11.0/docs/history.md +0 -48
  94. dremio_cli-1.11.0/docs/init.md +0 -34
  95. dremio_cli-1.11.0/docs/installation.md +0 -46
  96. dremio_cli-1.11.0/docs/jobs.md +0 -387
  97. dremio_cli-1.11.0/docs/lineage.md +0 -25
  98. dremio_cli-1.11.0/docs/monitor.md +0 -20
  99. dremio_cli-1.11.0/docs/profiles.md +0 -147
  100. dremio_cli-1.11.0/docs/quickstart.md +0 -88
  101. dremio_cli-1.11.0/docs/reflections.md +0 -90
  102. dremio_cli-1.11.0/docs/repl.md +0 -30
  103. dremio_cli-1.11.0/docs/roles.md +0 -105
  104. dremio_cli-1.11.0/docs/scripts.md +0 -86
  105. dremio_cli-1.11.0/docs/sources.md +0 -542
  106. dremio_cli-1.11.0/docs/spaces-folders.md +0 -479
  107. dremio_cli-1.11.0/docs/sql.md +0 -490
  108. dremio_cli-1.11.0/docs/tables.md +0 -280
  109. dremio_cli-1.11.0/docs/tags-wiki.md +0 -538
  110. dremio_cli-1.11.0/docs/tui.md +0 -44
  111. dremio_cli-1.11.0/docs/users.md +0 -73
  112. dremio_cli-1.11.0/docs/views.md +0 -404
  113. dremio_cli-1.11.0/dremio_cli/__init__.py +0 -5
  114. dremio_cli-1.11.0/dremio_cli/__main__.py +0 -6
  115. dremio_cli-1.11.0/dremio_cli/cli.py +0 -127
  116. dremio_cli-1.11.0/dremio_cli/client/__init__.py +0 -1
  117. dremio_cli-1.11.0/dremio_cli/client/auth.py +0 -210
  118. dremio_cli-1.11.0/dremio_cli/client/base.py +0 -204
  119. dremio_cli-1.11.0/dremio_cli/client/cloud.py +0 -384
  120. dremio_cli-1.11.0/dremio_cli/client/factory.py +0 -170
  121. dremio_cli-1.11.0/dremio_cli/client/software.py +0 -636
  122. dremio_cli-1.11.0/dremio_cli/commands/__init__.py +0 -1
  123. dremio_cli-1.11.0/dremio_cli/commands/catalog.py +0 -143
  124. dremio_cli-1.11.0/dremio_cli/commands/completion.py +0 -22
  125. dremio_cli-1.11.0/dremio_cli/commands/favorite.py +0 -162
  126. dremio_cli-1.11.0/dremio_cli/commands/folder.py +0 -290
  127. dremio_cli-1.11.0/dremio_cli/commands/grant.py +0 -202
  128. dremio_cli-1.11.0/dremio_cli/commands/history.py +0 -122
  129. dremio_cli-1.11.0/dremio_cli/commands/init.py +0 -98
  130. dremio_cli-1.11.0/dremio_cli/commands/job.py +0 -403
  131. dremio_cli-1.11.0/dremio_cli/commands/lineage.py +0 -88
  132. dremio_cli-1.11.0/dremio_cli/commands/monitor.py +0 -103
  133. dremio_cli-1.11.0/dremio_cli/commands/profile.py +0 -174
  134. dremio_cli-1.11.0/dremio_cli/commands/reflection.py +0 -273
  135. dremio_cli-1.11.0/dremio_cli/commands/repl.py +0 -112
  136. dremio_cli-1.11.0/dremio_cli/commands/role.py +0 -319
  137. dremio_cli-1.11.0/dremio_cli/commands/script.py +0 -277
  138. dremio_cli-1.11.0/dremio_cli/commands/source.py +0 -375
  139. dremio_cli-1.11.0/dremio_cli/commands/space.py +0 -226
  140. dremio_cli-1.11.0/dremio_cli/commands/sql.py +0 -384
  141. dremio_cli-1.11.0/dremio_cli/commands/sync.py +0 -51
  142. dremio_cli-1.11.0/dremio_cli/commands/table.py +0 -155
  143. dremio_cli-1.11.0/dremio_cli/commands/tag.py +0 -145
  144. dremio_cli-1.11.0/dremio_cli/commands/udf.py +0 -9
  145. dremio_cli-1.11.0/dremio_cli/commands/ui.py +0 -20
  146. dremio_cli-1.11.0/dremio_cli/commands/user.py +0 -250
  147. dremio_cli-1.11.0/dremio_cli/commands/view.py +0 -369
  148. dremio_cli-1.11.0/dremio_cli/commands/wiki.py +0 -163
  149. dremio_cli-1.11.0/dremio_cli/config.py +0 -203
  150. dremio_cli-1.11.0/dremio_cli/dac/__init__.py +0 -3
  151. dremio_cli-1.11.0/dremio_cli/dac/config.py +0 -42
  152. dremio_cli-1.11.0/dremio_cli/dac/diff.py +0 -26
  153. dremio_cli-1.11.0/dremio_cli/dac/graph.py +0 -69
  154. dremio_cli-1.11.0/dremio_cli/dac/state.py +0 -119
  155. dremio_cli-1.11.0/dremio_cli/dac/sync.py +0 -863
  156. dremio_cli-1.11.0/dremio_cli/env.py +0 -187
  157. dremio_cli-1.11.0/dremio_cli/formatters/__init__.py +0 -1
  158. dremio_cli-1.11.0/dremio_cli/formatters/json.py +0 -19
  159. dremio_cli-1.11.0/dremio_cli/formatters/table.py +0 -45
  160. dremio_cli-1.11.0/dremio_cli/formatters/yaml.py +0 -17
  161. dremio_cli-1.11.0/dremio_cli/history.py +0 -198
  162. dremio_cli-1.11.0/dremio_cli/tui/catalog/__init__.py +0 -1
  163. dremio_cli-1.11.0/dremio_cli/tui/catalog/app.py +0 -34
  164. dremio_cli-1.11.0/dremio_cli/tui/catalog/screens.py +0 -117
  165. dremio_cli-1.11.0/dremio_cli/tui/catalog/widgets.py +0 -180
  166. dremio_cli-1.11.0/dremio_cli/utils/__init__.py +0 -1
  167. dremio_cli-1.11.0/dremio_cli/utils/console.py +0 -4
  168. dremio_cli-1.11.0/dremio_cli/utils/exceptions.py +0 -35
  169. dremio_cli-1.11.0/dremio_cli/utils/helpers.py +0 -73
  170. dremio_cli-1.11.0/dremio_cli/utils/validators.py +0 -147
  171. dremio_cli-1.11.0/dremio_cli.egg-info/PKG-INFO +0 -290
  172. dremio_cli-1.11.0/dremio_cli.egg-info/SOURCES.txt +0 -121
  173. dremio_cli-1.11.0/dremio_cli.egg-info/dependency_links.txt +0 -1
  174. dremio_cli-1.11.0/dremio_cli.egg-info/entry_points.txt +0 -2
  175. dremio_cli-1.11.0/dremio_cli.egg-info/requires.txt +0 -16
  176. dremio_cli-1.11.0/dremio_cli.egg-info/top_level.txt +0 -1
  177. dremio_cli-1.11.0/pyproject.toml +0 -113
  178. dremio_cli-1.11.0/setup.cfg +0 -4
  179. dremio_cli-1.11.0/setup.py +0 -52
  180. dremio_cli-1.11.0/tests/__init__.py +0 -1
  181. dremio_cli-1.11.0/tests/conftest.py +0 -27
  182. dremio_cli-1.11.0/tests/test_config.py +0 -111
  183. dremio_cli-1.11.0/tests/test_grant_commands.py +0 -40
  184. dremio_cli-1.11.0/tests/test_history_favorite.py +0 -108
  185. dremio_cli-1.11.0/tests/test_integration.py +0 -144
  186. dremio_cli-1.11.0/tests/test_job_commands.py +0 -52
  187. dremio_cli-1.11.0/tests/test_multi_sql_execution.py +0 -142
  188. dremio_cli-1.11.0/tests/test_reflection_commands.py +0 -74
  189. dremio_cli-1.11.0/tests/test_role_commands.py +0 -58
  190. dremio_cli-1.11.0/tests/test_script_commands.py +0 -99
  191. dremio_cli-1.11.0/tests/test_source_commands.py +0 -58
  192. dremio_cli-1.11.0/tests/test_space_folder_commands.py +0 -74
  193. dremio_cli-1.11.0/tests/test_sql_commands.py +0 -39
  194. dremio_cli-1.11.0/tests/test_table_commands.py +0 -34
  195. dremio_cli-1.11.0/tests/test_tag_wiki_commands.py +0 -56
  196. dremio_cli-1.11.0/tests/test_user_commands.py +0 -46
  197. dremio_cli-1.11.0/tests/test_view_commands.py +0 -57
@@ -0,0 +1,11 @@
1
+ {
2
+ "schema_version": "1.0",
3
+ "name": "dremio/cli",
4
+ "description": "Dremio developer tools — CLI, MCP server, and Claude Code skills for query, catalog, schema, reflections, jobs, and access management.",
5
+ "plugins": [
6
+ {
7
+ "name": "dremio",
8
+ "path": "./plugins/dremio"
9
+ }
10
+ ]
11
+ }
@@ -0,0 +1,33 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ permissions:
10
+ contents: read
11
+
12
+ jobs:
13
+ lint:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+ - uses: astral-sh/setup-uv@v4
18
+ - run: uv sync --frozen
19
+ - run: uv run ruff check .
20
+ - run: uv run ruff format --check .
21
+
22
+ test:
23
+ runs-on: ubuntu-latest
24
+ strategy:
25
+ matrix:
26
+ python-version: ["3.11", "3.12", "3.13"]
27
+ steps:
28
+ - uses: actions/checkout@v4
29
+ - uses: astral-sh/setup-uv@v4
30
+ with:
31
+ python-version: ${{ matrix.python-version }}
32
+ - run: uv sync --frozen
33
+ - run: uv run pytest tests/ -v
@@ -0,0 +1,59 @@
1
+ name: Release
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ permissions:
8
+ contents: read
9
+
10
+ jobs:
11
+ build:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v4
15
+ with:
16
+ fetch-depth: 0
17
+ - uses: astral-sh/setup-uv@v4
18
+ - run: uv build
19
+ - uses: actions/upload-artifact@v4
20
+ with:
21
+ name: dist
22
+ path: dist/
23
+
24
+ publish:
25
+ needs: build
26
+ runs-on: ubuntu-latest
27
+ permissions:
28
+ id-token: write
29
+ environment:
30
+ name: pypi
31
+ url: https://pypi.org/project/dremio-cli/
32
+ steps:
33
+ - uses: actions/download-artifact@v4
34
+ with:
35
+ name: dist
36
+ path: dist/
37
+ - uses: pypa/gh-action-pypi-publish@release/v1
38
+
39
+ update-plugin-version:
40
+ needs: publish
41
+ runs-on: ubuntu-latest
42
+ permissions:
43
+ contents: write
44
+ steps:
45
+ - uses: actions/checkout@v4
46
+ with:
47
+ ref: main
48
+ - name: Update plugin.json version
49
+ run: |
50
+ VERSION="${GITHUB_REF_NAME#v}"
51
+ jq --arg v "$VERSION" '.version = $v' plugins/dremio/.claude-plugin/plugin.json > tmp.json
52
+ mv tmp.json plugins/dremio/.claude-plugin/plugin.json
53
+ - name: Commit and push
54
+ run: |
55
+ git config user.name "github-actions[bot]"
56
+ git config user.email "github-actions[bot]@users.noreply.github.com"
57
+ git add plugins/dremio/.claude-plugin/plugin.json
58
+ git diff --cached --quiet || git commit -m "chore: bump plugin version to ${GITHUB_REF_NAME#v}"
59
+ git push
@@ -0,0 +1,17 @@
1
+ # Python-generated files
2
+ __pycache__/
3
+ *.py[oc]
4
+ build/
5
+ dist/
6
+ wheels/
7
+ *.egg-info
8
+
9
+ # Virtual environments
10
+ .venv
11
+
12
+ # Generated reports
13
+ docs/API_COVERAGE_REPORT.txt
14
+ docs/*.json
15
+
16
+ # Generated version file
17
+ src/drs/_version.py
@@ -0,0 +1,13 @@
1
+ Copyright (C) 2017-2026 Dremio Corporation
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
@@ -0,0 +1,15 @@
1
+ repos:
2
+ - repo: https://github.com/astral-sh/ruff-pre-commit
3
+ rev: v0.8.6
4
+ hooks:
5
+ - id: ruff
6
+ args: [--fix]
7
+ - id: ruff-format
8
+ - repo: https://github.com/Lucas-C/pre-commit-hooks
9
+ rev: v1.5.6
10
+ hooks:
11
+ - id: insert-license
12
+ files: \.py$
13
+ args:
14
+ - --license-filepath=.license-header.txt
15
+ - --comment-style=#
@@ -0,0 +1 @@
1
+ 3.14
@@ -0,0 +1,77 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, sex characteristics, gender identity and expression,
9
+ level of experience, education, socio-economic status, nationality, personal
10
+ appearance, race, religion, or sexual identity and orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at codeofconduct@dremio.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72
+
73
+ [homepage]: https://www.contributor-covenant.org
74
+
75
+ For answers to common questions about this code of conduct, see
76
+ https://www.contributor-covenant.org/faq
77
+
@@ -0,0 +1,98 @@
1
+ # Contributing to dremio-cli
2
+
3
+ Thank you for your interest in contributing to dremio-cli! This document explains how to get started.
4
+
5
+ Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
6
+
7
+ ## Development Setup
8
+
9
+ ### Prerequisites
10
+
11
+ - Python 3.11 or later
12
+ - [uv](https://docs.astral.sh/uv/) package manager
13
+
14
+ ### Getting Started
15
+
16
+ ```bash
17
+ git clone https://github.com/dremio/cli.git
18
+ cd cli
19
+ uv sync
20
+ uv run dremio --help
21
+ ```
22
+
23
+ ### Pre-commit Hooks
24
+
25
+ Install pre-commit hooks to automatically run linting and license header checks on each commit:
26
+
27
+ ```bash
28
+ uv run pre-commit install
29
+ ```
30
+
31
+ ## Running Tests
32
+
33
+ ```bash
34
+ uv run pytest tests/ -v
35
+ ```
36
+
37
+ ## Linting and Formatting
38
+
39
+ This project uses [ruff](https://docs.astral.sh/ruff/) for linting and formatting.
40
+
41
+ Check for issues:
42
+
43
+ ```bash
44
+ uv run ruff check .
45
+ uv run ruff format --check .
46
+ ```
47
+
48
+ Auto-fix:
49
+
50
+ ```bash
51
+ uv run ruff check --fix .
52
+ uv run ruff format .
53
+ ```
54
+
55
+ ## Pull Request Process
56
+
57
+ 1. Fork the repository and create a feature branch from `main`.
58
+ 2. Make your changes, ensuring tests pass and linting is clean.
59
+ 3. Push your branch and open a pull request against `main`.
60
+ 4. CI will automatically run lint and test checks.
61
+ 5. A maintainer will review your pull request.
62
+
63
+ ## License Headers
64
+
65
+ All Python source files must include the Apache 2.0 license header. This is enforced by a pre-commit hook. New files should start with:
66
+
67
+ ```python
68
+ #
69
+ # Copyright (C) 2017-2026 Dremio Corporation
70
+ #
71
+ # Licensed under the Apache License, Version 2.0 (the "License");
72
+ # you may not use this file except in compliance with the License.
73
+ # You may obtain a copy of the License at
74
+ #
75
+ # http://www.apache.org/licenses/LICENSE-2.0
76
+ #
77
+ # Unless required by applicable law or agreed to in writing, software
78
+ # distributed under the License is distributed on an "AS IS" BASIS,
79
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
80
+ # See the License for the specific language governing permissions and
81
+ # limitations under the License.
82
+ #
83
+ ```
84
+
85
+ ## Reporting Issues
86
+
87
+ Use [GitHub Issues](https://github.com/dremio/cli/issues) to report bugs or request features. Please include steps to reproduce the issue.
88
+
89
+ ## Releasing (Maintainers)
90
+
91
+ Releases are automated via GitHub Actions:
92
+
93
+ 1. Ensure `main` is green (CI passes).
94
+ 2. Create a [GitHub release](https://github.com/dremio/cli/releases/new) with a tag following semver (e.g., `v2.1.0`).
95
+ 3. The release workflow automatically builds, publishes to PyPI, and updates the Claude Code plugin version.
96
+ 4. Verify at `https://pypi.org/project/dremio-cli/`.
97
+
98
+ Version is derived from the git tag via [hatch-vcs](https://github.com/ofek/hatch-vcs) — no manual version bumping is needed.