metaso-sdk 0.1.0__tar.gz

metaso_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+<!-- insertion marker -->

metaso_sdk-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,150 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+## Environment setup
+
+Nothing easier!
+
+Fork and clone the repository, then:
+
+```bash
+cd metaso-sdk
+make setup
+```
+
+> NOTE:
+> If it fails for some reason,
+> you'll need to install
+> [uv](https://github.com/astral-sh/uv)
+> manually.
+>
+> You can install it with:
+>
+> ```bash
+> curl -LsSf https://astral.sh/uv/install.sh | sh
+> ```
+>
+> Now you can try running `make setup` again,
+> or simply `uv sync`.
+
+You now have the dependencies installed.
+
+You can run the application with `make run metaso [ARGS...]`.
+
+Run `make help` to see all the available actions!
+
+## Tasks
+
+The entry-point to run commands and tasks is the `make` Python script,
+located in the `scripts` directory. Try running `make` to show the available commands and tasks.
+The *commands* do not need the Python dependencies to be installed,
+while the *tasks* do.
+The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
+
+If you work in VSCode, we provide
+[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)
+for the project.
+
+## Development
+
+As usual:
+
+1. create a new branch: `git switch -c feature-or-bugfix-name`
+1. edit the code and/or the documentation
+
+**Before committing:**
+
+1. run `make format` to auto-format the code
+1. run `make check` to check everything (fix any warning)
+1. run `make test` to run the tests (fix any issue)
+1. if you updated the documentation or the project dependencies:
+    1. run `make docs`
+    1. go to http://localhost:8000 and check that everything looks good
+1. follow our [commit message convention](#commit-message-convention)
+
+If you are unsure about how to fix or ignore a warning,
+just let the continuous integration fail,
+and we will help you during review.
+
+Don't bother updating the changelog, we will take care of this.
+
+## Commit message convention
+
+Commit messages must follow our convention based on the
+[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
+or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
+
+```
+<type>[(scope)]: Subject
+
+[Body]
+```
+
+**Subject and body must be valid Markdown.**
+Subject must have proper casing (uppercase for first letter
+if it makes sense), but no dot at the end, and no punctuation
+in general.
+
+Scope and body are optional. Type can be:
+
+- `build`: About packaging, building wheels, etc.
+- `chore`: About packaging or repo/files management.
+- `ci`: About Continuous Integration.
+- `deps`: Dependencies update.
+- `docs`: About documentation.
+- `feat`: New feature.
+- `fix`: Bug fix.
+- `perf`: About performance.
+- `refactor`: Changes that are not features or bug fixes.
+- `style`: A change in code style/format.
+- `tests`: About tests.
+
+If you write a body, please add trailers at the end
+(for example issues and PR references, or co-authors),
+without relying on GitHub's flavored Markdown:
+
+```
+Body.
+
+Issue #10: https://github.com/namespace/project/issues/10
+Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
+```
+
+These "trailers" must appear at the end of the body,
+without any blank lines between them. The trailer title
+can contain any character except colons `:`.
+We expect a full URI for each trailer, not just GitHub autolinks
+(for example, full GitHub URLs for commits and issues,
+not the hash or the #issue-number).
+
+We do not enforce a line length on commit messages summary and body,
+but please avoid very long summaries, and very long lines in the body,
+unless they are part of code blocks that must not be wrapped.
+
+## Pull requests guidelines
+
+Link to any related issue in the Pull Request message.
+
+During the review, we recommend using fixups:
+
+```bash
+# SHA is the SHA of the commit you want to fix
+git commit --fixup=SHA
+```
+
+Once all the changes are approved, you can squash your commits:
+
+```bash
+git rebase -i --autosquash main
+```
+
+And force-push:
+
+```bash
+git push -f
+```
+
+If this seems all too complicated, you can push or force-push each new commit,
+and we will squash them ourselves if needed, before merging.

metaso_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MetaSota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

metaso_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.1
+Name: metaso-sdk
+Version: 0.1.0
+Summary: The official Python SDK for https://metaso.cn
+Author-Email: Zhao Xiaohong <zhaoxiaohong@metasota.ai>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://meta-sota.github.io/metaso-sdk
+Project-URL: Documentation, https://meta-sota.github.io/metaso-sdk
+Project-URL: Changelog, https://meta-sota.github.io/metaso-sdk/changelog
+Project-URL: Repository, https://github.com/meta-sota/metaso-sdk
+Project-URL: Issues, https://github.com/meta-sota/metaso-sdk/issues
+Project-URL: Discussions, https://github.com/meta-sota/metaso-sdk/discussions
+Project-URL: Gitter, https://gitter.im/metaso-sdk/community
+Project-URL: Funding, https://github.com/sponsors/meta-sota
+Requires-Python: >=3.8
+Requires-Dist: httpx-sse>=0.4.0
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: pydantic>=2.10.0
+Requires-Dist: streamable>=1.3.5
+Description-Content-Type: text/markdown
+
+# metaso-sdk
+
+[![ci](https://github.com/meta-sota/metaso-sdk/workflows/ci/badge.svg)](https://github.com/meta-sota/metaso-sdk/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://meta-sota.github.io/metaso-sdk/)
+[![pypi version](https://img.shields.io/pypi/v/metaso-sdk.svg)](https://pypi.org/project/metaso-sdk/)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#metaso-sdk:gitter.im)
+
+The official Python SDK for https://metaso.cn
+
+## 安装
+
+```bash
+pip install metaso-sdk
+```
+
+## 配置 METASO_API_KEY
+
+metaso-sdk 从环境变量 `METASO_API_KEY` 读取用于认证的 API 密钥，可以在 shell 里进行设置：
+
+```bash
+export METASO_API_KEY="mk-EE2..."
+```
+
+或者在 Python 代码里进行设置：
+
+```python
+import os
+os.environ["METASO_API_KEY"] = "mk-EE2..."
+```
+
+## 搜索
+
+### 搜索问题
+```python
+from metaso_sdk import search, Query
+search(Query(question="abc"))
+```
+
+### 追问
+
+```python
+search(Query(question="广播公司", sessionId='8550018047390023680'))
+```
+
+### 流式返回
+
+```python
+for chunk in search(Query(question="abc"), stream=True):
+    print(chunk)
+
+...
+{'type': 'heartbeat'}
+{'text': '因此，“abc”可以指代字母表的前三个字母、美籍华裔、美国广播公司、一种音乐记谱法以及一种编程语言。具体含义需要根据上下文来确定。', 'type': 'append-text'}
+```
+
+## 专题
+
+### 递归上传文件夹
+
+```
+from metaso_sdk import create_topic, upload_directory, Topic
+
+topic = create_topic(Topic(name="functional programing"))
+files = upload_directory(topic, "dir")
+```
+
+### 搜索特定专题
+
+```python
+from metaso_sdk import search, Query
+
+query = Query(question="functional")
+search(query, topic=topic)
+```

metaso_sdk-0.1.0/README.md

@@ -0,0 +1,74 @@
+# metaso-sdk
+
+[![ci](https://github.com/meta-sota/metaso-sdk/workflows/ci/badge.svg)](https://github.com/meta-sota/metaso-sdk/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://meta-sota.github.io/metaso-sdk/)
+[![pypi version](https://img.shields.io/pypi/v/metaso-sdk.svg)](https://pypi.org/project/metaso-sdk/)
+[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#metaso-sdk:gitter.im)
+
+The official Python SDK for https://metaso.cn
+
+## 安装
+
+```bash
+pip install metaso-sdk
+```
+
+## 配置 METASO_API_KEY
+
+metaso-sdk 从环境变量 `METASO_API_KEY` 读取用于认证的 API 密钥，可以在 shell 里进行设置：
+
+```bash
+export METASO_API_KEY="mk-EE2..."
+```
+
+或者在 Python 代码里进行设置：
+
+```python
+import os
+os.environ["METASO_API_KEY"] = "mk-EE2..."
+```
+
+## 搜索
+
+### 搜索问题
+```python
+from metaso_sdk import search, Query
+search(Query(question="abc"))
+```
+
+### 追问
+
+```python
+search(Query(question="广播公司", sessionId='8550018047390023680'))
+```
+
+### 流式返回
+
+```python
+for chunk in search(Query(question="abc"), stream=True):
+    print(chunk)
+
+...
+{'type': 'heartbeat'}
+{'text': '因此，“abc”可以指代字母表的前三个字母、美籍华裔、美国广播公司、一种音乐记谱法以及一种编程语言。具体含义需要根据上下文来确定。', 'type': 'append-text'}
+```
+
+## 专题
+
+### 递归上传文件夹
+
+```
+from metaso_sdk import create_topic, upload_directory, Topic
+
+topic = create_topic(Topic(name="functional programing"))
+files = upload_directory(topic, "dir")
+```
+
+### 搜索特定专题
+
+```python
+from metaso_sdk import search, Query
+
+query = Query(question="functional")
+search(query, topic=topic)
+```

metaso_sdk-0.1.0/config/coverage.ini

@@ -0,0 +1,25 @@
+[coverage:run]
+branch = true
+parallel = true
+source =
+  src/
+  tests/
+
+[coverage:paths]
+equivalent =
+  src/
+  .venv/lib/*/site-packages/
+  .venvs/*/lib/*/site-packages/
+
+[coverage:report]
+precision = 2
+omit =
+  src/*/__init__.py
+  src/*/__main__.py
+  tests/__init__.py
+exclude_lines =
+  pragma: no cover
+  if TYPE_CHECKING
+
+[coverage:json]
+output = htmlcov/coverage.json

metaso_sdk-0.1.0/config/git-changelog.toml

@@ -0,0 +1,9 @@
+bump = "auto"
+convention = "angular"
+in-place = true
+output = "CHANGELOG.md"
+parse-refs = false
+parse-trailers = true
+sections = ["build", "deps", "feat", "fix", "refactor"]
+template = "keepachangelog"
+versioning = "pep440"

metaso_sdk-0.1.0/config/mypy.ini

@@ -0,0 +1,5 @@
+[mypy]
+ignore_missing_imports = true
+exclude = tests/fixtures/
+warn_unused_ignores = true
+show_error_codes = true

metaso_sdk-0.1.0/config/pytest.ini

@@ -0,0 +1,14 @@
+[pytest]
+python_files =
+  test_*.py
+addopts =
+  --cov
+  --cov-config config/coverage.ini
+testpaths =
+  tests
+
+# action:message_regex:warning_class:module_regex:line
+filterwarnings =
+  error
+  # TODO: remove once pytest-xdist 4 is released
+  ignore:.*rsyncdir:DeprecationWarning:xdist

metaso_sdk-0.1.0/config/ruff.toml

@@ -0,0 +1,84 @@
+target-version = "py39"
+line-length = 120
+
+[lint]
+exclude = [
+    "tests/fixtures/*.py",
+]
+select = [
+    "A", "ANN", "ARG",
+    "B", "BLE",
+    "C", "C4",
+    "COM",
+    "D", "DTZ",
+    "E", "ERA", "EXE",
+    "F", "FBT",
+    "G",
+    "I", "ICN", "INP", "ISC",
+    "N",
+    "PGH", "PIE", "PL", "PLC", "PLE", "PLR", "PLW", "PT", "PYI",
+    "Q",
+    "RUF", "RSE", "RET",
+    "S", "SIM", "SLF",
+    "T", "T10", "T20", "TCH", "TID", "TRY",
+    "UP",
+    "W",
+    "YTT",
+]
+ignore = [
+    "A001",  # Variable is shadowing a Python builtin
+    "ANN101",  # Missing type annotation for self
+    "ANN102",  # Missing type annotation for cls
+    "ANN204",  # Missing return type annotation for special method __str__
+    "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed
+    "ARG005",  # Unused lambda argument
+    "C901",  # Too complex
+    "D105",  # Missing docstring in magic method
+    "D417",  # Missing argument description in the docstring
+    "E501",  # Line too long
+    "ERA001",  # Commented out code
+    "G004",  # Logging statement uses f-string
+    "PLR0911",  # Too many return statements
+    "PLR0912",  # Too many branches
+    "PLR0913",  # Too many arguments to function call
+    "PLR0915",  # Too many statements
+    "SLF001", # Private member accessed
+    "TRY003",  # Avoid specifying long messages outside the exception class
+]
+
+[lint.per-file-ignores]
+"src/*/cli.py" = [
+    "T201",  # Print statement
+]
+"src/*/debug.py" = [
+    "T201",  # Print statement
+]
+"scripts/*.py" = [
+    "INP001",  # File is part of an implicit namespace package
+    "T201",  # Print statement
+]
+"tests/*.py" = [
+    "ARG005",  # Unused lambda argument
+    "FBT001",  # Boolean positional arg in function definition
+    "PLR2004",  # Magic value used in comparison
+    "S101",  # Use of assert detected
+]
+
+[lint.flake8-quotes]
+docstring-quotes = "double"
+
+[lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[lint.isort]
+known-first-party = ["metaso_sdk"]
+
+[lint.pydocstyle]
+convention = "google"
+
+[format]
+exclude = [
+    "tests/fixtures/*.py",
+]
+docstring-code-format = true
+docstring-code-line-length = 80

metaso_sdk-0.1.0/config/vscode/launch.json

@@ -0,0 +1,47 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "python (current file)",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": false
+        },
+        {
+            "name": "docs",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "mkdocs",
+            "justMyCode": false,
+            "args": [
+                "serve",
+                "-v"
+            ]
+        },
+        {
+            "name": "test",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "justMyCode": false,
+            "args": [
+                "-c=config/pytest.ini",
+                "-vvv",
+                "--no-cov",
+                "--dist=no",
+                "tests",
+                "-k=${input:tests_selection}"
+            ]
+        }
+    ],
+    "inputs": [
+        {
+            "id": "tests_selection",
+            "type": "promptString",
+            "description": "Tests selection",
+            "default": ""
+        }
+    ]
+}

metaso_sdk-0.1.0/config/vscode/settings.json

@@ -0,0 +1,33 @@
+{
+    "files.watcherExclude": {
+        "**/.venv*/**": true,
+        "**/.venvs*/**": true,
+        "**/venv*/**": true
+    },
+    "mypy-type-checker.args": [
+        "--config-file=config/mypy.ini"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        "--config-file=config/pytest.ini"
+    ],
+    "ruff.enable": true,
+    "ruff.format.args": [
+        "--config=config/ruff.toml"
+    ],
+    "ruff.lint.args": [
+        "--config=config/ruff.toml"
+    ],
+    "yaml.schemas": {
+        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [
+        "!ENV scalar",
+        "!ENV sequence",
+        "!relative scalar",
+        "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
+        "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
+        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ]
+}

metaso_sdk-0.1.0/config/vscode/tasks.json

@@ -0,0 +1,97 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "changelog",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["changelog"]
+        },
+        {
+            "label": "check",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["check"]
+        },
+        {
+            "label": "check-quality",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["check-quality"]
+        },
+        {
+            "label": "check-types",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["check-types"]
+        },
+        {
+            "label": "check-docs",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["check-docs"]
+        },
+        {
+            "label": "check-api",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["check-api"]
+        },
+        {
+            "label": "clean",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["clean"]
+        },
+        {
+            "label": "docs",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["docs"]
+        },
+        {
+            "label": "docs-deploy",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["docs-deploy"]
+        },
+        {
+            "label": "format",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["format"]
+        },
+        {
+            "label": "release",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["release", "${input:version}"]
+        },
+        {
+            "label": "setup",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["setup"]
+        },
+        {
+            "label": "test",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["test", "coverage"],
+            "group": "test"
+        },
+        {
+            "label": "vscode",
+            "type": "process",
+            "command": "scripts/make",
+            "args": ["vscode"]
+        }
+    ],
+    "inputs": [
+        {
+            "id": "version",
+            "type": "promptString",
+            "description": "Version"
+        }
+    ]
+}