deepset-ai / deepset-ai/deepset-cloud-sdk
As a user i want sync local files <> dC workspace
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 16
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
User Story
As a user i want to keep the workspace updated with my files, when for example running periodic syncs (e.g. syncing a database/directory/gh repo content/...)
Option: Synchornizing two states can have quite individual rules to be followed. One solution would be to just implement deletions and users can implement a (simple) script that fits their needs. Additionally we can document this case.
Relevant Links
- we already provide the
write_mode(docs) to overwrite files if a file with the same name already exists
Acceptance Criteria
- a user can sync a local directory/list of files with deepset Cloud
### Tasks
- [ ] https://github.com/deepset-ai/deepset-cloud-sdk/issues/112
- [ ] (optional) add sync method that updates existing files and deletes old ones
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading issue #112 and the existing write_mode documentation, since no implementation files or tests are named here. Clarify whether the goal is only local-to-cloud additions or also updates and deletions; the work is done when a local directory or file list can be synchronized with deepset Cloud according to the agreed rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cloud
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100