knowhere-python-sdk 0.3.1__tar.gz → 0.3.2__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 (67) hide show
  1. knowhere_python_sdk-0.3.2/.github/ISSUE_TEMPLATE/bug-report.yml +45 -0
  2. knowhere_python_sdk-0.3.2/.github/ISSUE_TEMPLATE/config.yml +8 -0
  3. knowhere_python_sdk-0.3.2/.github/ISSUE_TEMPLATE/feature-request.yml +25 -0
  4. knowhere_python_sdk-0.3.2/.github/pull_request_template.md +15 -0
  5. knowhere_python_sdk-0.3.2/.release-please-manifest.json +3 -0
  6. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/CHANGELOG.md +8 -0
  7. knowhere_python_sdk-0.3.2/CODE_OF_CONDUCT.md +29 -0
  8. knowhere_python_sdk-0.3.2/CONTRIBUTING.md +44 -0
  9. knowhere_python_sdk-0.3.2/LICENSE +21 -0
  10. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/PKG-INFO +8 -1
  11. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/README.md +6 -0
  12. knowhere_python_sdk-0.3.2/SECURITY.md +24 -0
  13. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/pyproject.toml +1 -1
  14. knowhere_python_sdk-0.3.2/src/knowhere/_version.py +1 -0
  15. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_logging.py +1 -1
  16. knowhere_python_sdk-0.3.1/.release-please-manifest.json +0 -3
  17. knowhere_python_sdk-0.3.1/src/knowhere/_version.py +0 -1
  18. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/.github/workflows/ci.yml +0 -0
  19. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/.github/workflows/publish-pypi.yml +0 -0
  20. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/.github/workflows/publish.yml +0 -0
  21. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/.gitignore +0 -0
  22. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/docs/usage.md +0 -0
  23. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/examples/async_usage.py +0 -0
  24. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/examples/error_handling.py +0 -0
  25. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/examples/parse_file.py +0 -0
  26. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/examples/parse_url.py +0 -0
  27. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/examples/step_by_step.py +0 -0
  28. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/release-please-config.json +0 -0
  29. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/__init__.py +0 -0
  30. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_base_client.py +0 -0
  31. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_client.py +0 -0
  32. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_constants.py +0 -0
  33. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_exceptions.py +0 -0
  34. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_logging.py +0 -0
  35. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_response.py +0 -0
  36. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/_types.py +0 -0
  37. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/lib/__init__.py +0 -0
  38. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/lib/polling.py +0 -0
  39. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/lib/result_parser.py +0 -0
  40. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/lib/upload.py +0 -0
  41. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/py.typed +0 -0
  42. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/resources/__init__.py +0 -0
  43. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/resources/_base.py +0 -0
  44. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/resources/documents.py +0 -0
  45. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/resources/jobs.py +0 -0
  46. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/resources/retrieval.py +0 -0
  47. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/__init__.py +0 -0
  48. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/document.py +0 -0
  49. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/job.py +0 -0
  50. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/params.py +0 -0
  51. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/result.py +0 -0
  52. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/retrieval.py +0 -0
  53. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/src/knowhere/types/shared.py +0 -0
  54. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/__init__.py +0 -0
  55. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/conftest.py +0 -0
  56. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/fixtures/real_result.zip +0 -0
  57. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_client.py +0 -0
  58. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_documents.py +0 -0
  59. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_exceptions.py +0 -0
  60. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_jobs.py +0 -0
  61. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_models.py +0 -0
  62. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_parse.py +0 -0
  63. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_polling.py +0 -0
  64. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_result_parser.py +0 -0
  65. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_retrieval.py +0 -0
  66. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_retry.py +0 -0
  67. {knowhere_python_sdk-0.3.1 → knowhere_python_sdk-0.3.2}/tests/test_upload.py +0 -0
@@ -0,0 +1,45 @@
1
+ name: Bug report
2
+ description: Report a reproducible problem in the Python SDK.
3
+ title: "[Bug]: "
4
+ labels:
5
+ - bug
6
+ body:
7
+ - type: textarea
8
+ id: summary
9
+ attributes:
10
+ label: Summary
11
+ description: What happened, and what did you expect instead?
12
+ validations:
13
+ required: true
14
+ - type: input
15
+ id: sdk-version
16
+ attributes:
17
+ label: SDK version
18
+ placeholder: 0.3.1
19
+ validations:
20
+ required: true
21
+ - type: input
22
+ id: python-version
23
+ attributes:
24
+ label: Python version
25
+ placeholder: 3.11.9
26
+ validations:
27
+ required: true
28
+ - type: input
29
+ id: os
30
+ attributes:
31
+ label: Operating system
32
+ placeholder: macOS 15.4 / Ubuntu 24.04
33
+ - type: textarea
34
+ id: reproduction
35
+ attributes:
36
+ label: Reproduction
37
+ description: Minimal code or steps to reproduce the issue.
38
+ render: python
39
+ validations:
40
+ required: true
41
+ - type: textarea
42
+ id: logs
43
+ attributes:
44
+ label: Relevant logs or tracebacks
45
+ render: text
@@ -0,0 +1,8 @@
1
+ blank_issues_enabled: false
2
+ contact_links:
3
+ - name: Knowhere documentation
4
+ url: https://docs.knowhereto.ai
5
+ about: Check the public docs before opening a support issue.
6
+ - name: Security report
7
+ url: mailto:team@knowhereto.ai?subject=Security%20report%20for%20knowhere-python-sdk
8
+ about: Report vulnerabilities privately by email.
@@ -0,0 +1,25 @@
1
+ name: Feature request
2
+ description: Propose an improvement for the Python SDK.
3
+ title: "[Feature]: "
4
+ labels:
5
+ - enhancement
6
+ body:
7
+ - type: textarea
8
+ id: problem
9
+ attributes:
10
+ label: Problem statement
11
+ description: What developer problem are you trying to solve?
12
+ validations:
13
+ required: true
14
+ - type: textarea
15
+ id: proposal
16
+ attributes:
17
+ label: Proposed solution
18
+ description: Describe the API or behavior you want to add or improve.
19
+ validations:
20
+ required: true
21
+ - type: textarea
22
+ id: alternatives
23
+ attributes:
24
+ label: Alternatives considered
25
+ description: Describe any workarounds or alternative designs you considered.
@@ -0,0 +1,15 @@
1
+ ## Summary
2
+
3
+ - describe the change
4
+ - describe any public API impact
5
+
6
+ ## Verification
7
+
8
+ - list the commands you ran
9
+ - list any manual checks you performed
10
+
11
+ ## Checklist
12
+
13
+ - [ ] Tests were added or updated when behavior changed
14
+ - [ ] Public docs or examples were updated when needed
15
+ - [ ] The pull request description explains any breaking or user-visible change
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "0.3.2"
3
+ }
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.3.2](https://github.com/Ontos-AI/knowhere-python-sdk/compare/v0.3.1...v0.3.2) (2026-04-23)
4
+
5
+
6
+ ### Chores
7
+
8
+ * harden python sdk OSS surface ([e7d9779](https://github.com/Ontos-AI/knowhere-python-sdk/commit/e7d9779502327d2bd9e4f27e666244d34f8fafb7))
9
+ * harden Python SDK OSS surface ([a9396cd](https://github.com/Ontos-AI/knowhere-python-sdk/commit/a9396cda70eabcba66172884e38045caefc85a01))
10
+
3
11
  ## [0.3.1](https://github.com/Ontos-AI/knowhere-python-sdk/compare/v0.3.0...v0.3.1) (2026-04-22)
4
12
 
5
13
 
@@ -0,0 +1,29 @@
1
+ # Code of Conduct
2
+
3
+ We want the Knowhere Python SDK community to be respectful, constructive, and
4
+ welcoming.
5
+
6
+ ## Expected Behavior
7
+
8
+ - Be respectful in discussions and code review.
9
+ - Assume good intent and give actionable feedback.
10
+ - Focus on technical substance instead of personal attacks.
11
+ - Help keep the project useful for a broad developer audience.
12
+
13
+ ## Unacceptable Behavior
14
+
15
+ - Harassment, discrimination, or hateful conduct
16
+ - Threats, intimidation, or doxxing
17
+ - Spam, trolling, or intentionally disruptive behavior
18
+ - Sharing private information without permission
19
+
20
+ ## Enforcement
21
+
22
+ Maintainers may edit or remove content, close discussions, or restrict access
23
+ when behavior harms the project or its contributors.
24
+
25
+ To report a problem, email `team@knowhereto.ai` with:
26
+
27
+ - the repository name
28
+ - a link or screenshot if available
29
+ - a short description of what happened
@@ -0,0 +1,44 @@
1
+ # Contributing
2
+
3
+ Thanks for contributing to the Knowhere Python SDK.
4
+
5
+ ## Development Setup
6
+
7
+ Requirements:
8
+
9
+ - Python 3.9+
10
+ - `uv`
11
+
12
+ Clone the repository and install the full development environment:
13
+
14
+ ```bash
15
+ uv sync --all-extras
16
+ ```
17
+
18
+ ## Local Checks
19
+
20
+ Run these commands before opening a pull request:
21
+
22
+ ```bash
23
+ uv run ruff check src/
24
+ uv run mypy src/knowhere
25
+ uv run pytest -q
26
+ ```
27
+
28
+ If you change public behavior, also update the relevant documentation in:
29
+
30
+ - `README.md`
31
+ - `docs/usage.md`
32
+ - `examples/`
33
+
34
+ ## Pull Requests
35
+
36
+ Please keep pull requests focused and easy to review.
37
+
38
+ Recommended checklist:
39
+
40
+ 1. Add or update tests for behavior changes.
41
+ 2. Keep public types and examples in sync with the implementation.
42
+ 3. Document any breaking or user-visible changes in the pull request description.
43
+
44
+ Maintainers handle versioning and release automation through GitHub Actions.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Knowhere Team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,12 +1,13 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: knowhere-python-sdk
3
- Version: 0.3.1
3
+ Version: 0.3.2
4
4
  Summary: Official Python SDK for the Knowhere document parsing API
5
5
  Project-URL: Homepage, https://knowhereto.ai
6
6
  Project-URL: Documentation, https://docs.knowhereto.ai
7
7
  Project-URL: Repository, https://github.com/Ontos-AI/knowhere-python-sdk
8
8
  Author-email: Knowhere Team <team@knowhereto.ai>
9
9
  License-Expression: MIT
10
+ License-File: LICENSE
10
11
  Classifier: Development Status :: 3 - Alpha
11
12
  Classifier: Intended Audience :: Developers
12
13
  Classifier: License :: OSI Approved :: MIT License
@@ -305,6 +306,12 @@ We publish stable releases to [PyPI](https://pypi.org/project/knowhere-python-sd
305
306
  - [pydantic](https://docs.pydantic.dev/) `>=2.0.0,<3.0`
306
307
  - [typing-extensions](https://pypi.org/project/typing-extensions/) `>=4.7.0`
307
308
 
309
+ ## Community
310
+
311
+ - Contributing guide: [CONTRIBUTING.md](./CONTRIBUTING.md)
312
+ - Security policy: [SECURITY.md](./SECURITY.md)
313
+ - Code of conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
314
+
308
315
  ## License
309
316
 
310
317
  MIT
@@ -273,6 +273,12 @@ We publish stable releases to [PyPI](https://pypi.org/project/knowhere-python-sd
273
273
  - [pydantic](https://docs.pydantic.dev/) `>=2.0.0,<3.0`
274
274
  - [typing-extensions](https://pypi.org/project/typing-extensions/) `>=4.7.0`
275
275
 
276
+ ## Community
277
+
278
+ - Contributing guide: [CONTRIBUTING.md](./CONTRIBUTING.md)
279
+ - Security policy: [SECURITY.md](./SECURITY.md)
280
+ - Code of conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
281
+
276
282
  ## License
277
283
 
278
284
  MIT
@@ -0,0 +1,24 @@
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ Only the latest published release line is supported for security fixes.
6
+
7
+ | Version | Supported |
8
+ | --- | --- |
9
+ | Latest release | Yes |
10
+ | Older releases | No |
11
+
12
+ ## Reporting a Vulnerability
13
+
14
+ Please do not open public GitHub issues for suspected vulnerabilities.
15
+
16
+ Instead, email `team@knowhereto.ai` with:
17
+
18
+ - the repository name
19
+ - a clear description of the issue
20
+ - reproduction steps or a proof of concept
21
+ - impact assessment if known
22
+
23
+ We will acknowledge the report, validate it, and coordinate remediation before
24
+ public disclosure.
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "knowhere-python-sdk"
7
- version = "0.3.1"
7
+ version = "0.3.2"
8
8
  description = "Official Python SDK for the Knowhere document parsing API"
9
9
  readme = "README.md"
10
10
  license = "MIT"
@@ -0,0 +1 @@
1
+ __version__ = "0.3.2" # x-release-please-version
@@ -18,7 +18,7 @@ class TestRedactSensitiveHeaders:
18
18
 
19
19
  def test_redacts_authorization_bearer(self) -> None:
20
20
  headers: Dict[str, str] = {
21
- "Authorization": "Bearer sk_live_abc123xyz",
21
+ "Authorization": "Bearer sk_example_redacted_token",
22
22
  "Content-Type": "application/json",
23
23
  }
24
24
  redacted: Dict[str, str] = redactSensitiveHeaders(headers)
@@ -1,3 +0,0 @@
1
- {
2
- ".": "0.3.1"
3
- }
@@ -1 +0,0 @@
1
- __version__ = "0.3.1" # x-release-please-version