Skip to content

Commit 973c504

Browse files
committed
chore: pass pre-commit checks
1 parent 556789f commit 973c504

File tree

63 files changed

+134
-150
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+134
-150
lines changed

.github/ISSUE_TEMPLATE/💡-feature-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ assignees: ''
1717

1818
---
1919
❤️ Contributors, please refer to 📙[Contributing Guide](https://cocoindex.io/docs/about/contributing).
20-
Unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work. Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is always open and friendly.
20+
Unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work. Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is always open and friendly.

.github/scripts/update_version.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ else
1919
fi
2020

2121
# Update Cargo.toml
22-
sed "${SED_INLINE[@]}" "s/^version = .*/version = \"$VERSION\"/" Cargo.toml
22+
sed "${SED_INLINE[@]}" "s/^version = .*/version = \"$VERSION\"/" Cargo.toml

.pre-commit-config.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ repos:
1818
# Checks for the existence of private keys.
1919
- id: end-of-file-fixer
2020
# Makes sure files end in a newline and only a newline.
21-
exclude: ".*(data.*|extern.*|licenses.*|_static.*|\\.ya?ml)$"
21+
exclude: ".*(data.*|licenses.*|_static.*|\\.ya?ml|\\.jpe?g|\\.png|\\.svg|\\.webp)$"
2222
- id: trailing-whitespace
2323
# Trims trailing whitespace.
24-
exclude_types: [python]
25-
exclude: ".*(data.*|extern.*|licenses.*|_static.*|\\.ya?ml)$"
24+
exclude_types: [python] # Covered by Ruff W291.
25+
exclude: ".*(data.*|licenses.*|_static.*|\\.ya?ml|\\.jpe?g|\\.png|\\.svg|\\.webp)$"
2626

2727
- repo: https://github.com/astral-sh/ruff-pre-commit
2828
rev: v0.12.0
@@ -68,3 +68,4 @@ repos:
6868
entry: cargo test
6969
language: system
7070
types: [rust]
71+
pass_filenames: false

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
],
77
"editor.formatOnSave": true,
88
"python.formatting.provider": "ruff"
9-
}
9+
}

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
We love contributions from our community ❤️. Please check out our [contributing guide](https://cocoindex.io/docs/about/contributing).
1+
We love contributions from our community ❤️. Please check out our [contributing guide](https://cocoindex.io/docs/about/contributing).

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Unlike a workflow orchestration framework where data is usually opaque, in CocoI
3232

3333
```python
3434
# import
35-
data['content'] = flow_builder.add_source(...)
35+
data['content'] = flow_builder.add_source(...)
3636

3737
# transform
38-
data['out'] = data['content']
38+
data['out'] = data['content']
3939
.transform(...)
4040
.transform(...)
4141

@@ -56,17 +56,17 @@ As a data framework, CocoIndex takes it to the next level on data freshness. **I
5656
The frameworks takes care of
5757
- Change data capture.
5858
- Figure out what exactly needs to be updated, and only updating that without having to recompute everything.
59-
59+
6060
This makes it fast to reflect any source updates to the target store. If you have concerns with surfacing stale data to AI agents and are spending lots of efforts working on infra piece to optimize the latency, the framework actually handles it for you.
6161

6262

6363
## Quick Start:
64-
If you're new to CocoIndex, we recommend checking out
64+
If you're new to CocoIndex, we recommend checking out
6565
- 📖 [Documentation](https://cocoindex.io/docs)
6666
-[Quick Start Guide](https://cocoindex.io/docs/getting_started/quickstart)
67-
- 🎬 [Quick Start Video Tutorial](https://youtu.be/gv5R8nOXsWU?si=9ioeKYkMEnYevTXT)
67+
- 🎬 [Quick Start Video Tutorial](https://youtu.be/gv5R8nOXsWU?si=9ioeKYkMEnYevTXT)
6868

69-
### Setup
69+
### Setup
7070

7171
1. Install CocoIndex Python library
7272

@@ -136,8 +136,8 @@ It defines an index flow like this:
136136
| [Google Drive Text Embedding](examples/gdrive_text_embedding) | Index text documents from Google Drive |
137137
| [Docs to Knowledge Graph](examples/docs_to_knowledge_graph) | Extract relationships from Markdown documents and build a knowledge graph |
138138
| [Embeddings to Qdrant](examples/text_embedding_qdrant) | Index documents in a Qdrant collection for semantic search |
139-
| [FastAPI Server with Docker](examples/fastapi_server_docker) | Run the semantic search server in a Dockerized FastAPI setup |
140-
| [Product Recommendation](examples/product_recommendation) | Build real-time product recommendations with LLM and graph database|
139+
| [FastAPI Server with Docker](examples/fastapi_server_docker) | Run the semantic search server in a Dockerized FastAPI setup |
140+
| [Product Recommendation](examples/product_recommendation) | Build real-time product recommendations with LLM and graph database|
141141
| [Image Search with Vision API](examples/image_search) | Generates detailed captions for images using a vision model, embeds them, enables live-updating semantic search via FastAPI and served on a React frontend|
142142

143143
More coming and stay tuned 👀!
@@ -159,7 +159,7 @@ Join our community here:
159159
- 📜 [Read our blog posts](https://cocoindex.io/blogs/)
160160

161161
## Support us:
162-
We are constantly improving, and more features and examples are coming soon. If you love this project, please drop us a star ⭐ at GitHub repo [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) to stay tuned and help us grow.
162+
We are constantly improving, and more features and examples are coming soon. If you love this project, please drop us a star ⭐ at GitHub repo [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) to stay tuned and help us grow.
163163

164164
## License
165165
CocoIndex is Apache 2.0 licensed.

check.sh

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/docs/ai/llm.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,9 @@ pip install 'litellm[proxy]'
136136
**Example for OpenAI:**
137137
```yaml
138138
model_list:
139-
- model_name: "*"
139+
- model_name: "*"
140140
litellm_params:
141-
model: openai/*
141+
model: openai/*
142142
api_key: os.environ/LITELLM_API_KEY
143143
```
144144
@@ -176,7 +176,7 @@ litellm --config config.yml
176176
```python
177177
cocoindex.LlmSpec(
178178
api_type=cocoindex.LlmApiType.LITE_LLM,
179-
model="deepseek-r1",
179+
model="deepseek-r1",
180180
address="http://127.0.0.1:4000", # default url of LiteLLM
181181
)
182182
```

docs/docs/core/basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ An indexing flow, once set up, maintains a long-lived relationship between data
7171

7272
* **One time update**: Once triggered, CocoIndex updates the target data to reflect the version of source data up to the current moment.
7373
* **Live update**: CocoIndex continuously reacts to changes of source data and updates the target data accordingly, based on various **change capture mechanisms** for the source.
74-
74+
7575
See more details in the [build / update target data](flow_methods#build--update-target-data) section.
7676

7777
3. CocoIndex intelligently reprocesses to propagate source changes to target by:
@@ -101,4 +101,4 @@ As an indexing flow is long-lived, it needs to store intermediate data to keep t
101101
CocoIndex uses internal storage for this purpose.
102102

103103
Currently, CocoIndex uses Postgres database as the internal storage.
104-
See [Settings](settings#databaseconnectionspec) for configuring its location, and `cocoindex setup` CLI command (see [CocoIndex CLI](cli)) creates tables for the internal storage.
104+
See [Settings](settings#databaseconnectionspec) for configuring its location, and `cocoindex setup` CLI command (see [CocoIndex CLI](cli)) creates tables for the internal storage.

docs/docs/core/cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ Use `--help` to see the full list of subcommands, and `subcommand --help` to see
7272
```sh
7373
cocoindex --help # Show all subcommands
7474
cocoindex show --help # Show usage of "show" subcommand
75-
```
75+
```

0 commit comments

Comments
 (0)