camel-ai/camel

[Feature Request] Refactor to use `api_keys_required` and `dependencies_required` decorators

Open

#1,043 opened on Oct 11, 2024

View on GitHubContributor guide
 (15 comments) (0 reactions) (1 assignee)Python (2,020 forks)auto 404
P1call for contributionenhancementgood first issue

Repository metrics

Stars
 (17,486 stars)
PR merge metrics
 (PR metrics pending)

Description

Required prerequisites

Motivation

  • Add error_info to decorators, to info users where to get the keys, or how to install dependencies.
  • Refactor camel.models
  • Refactor camel.toolkits
  • Refactor camel.storages
  • Refactor camel.retrievers
  • Refactor camel.interpreters
  • Refactor camel.loaders
  • Refactor camel.embeddings
  • Refactor camel.bots

Solution

No response

Alternatives

No response

Additional context

No response

Contributor guide

Research direction
Examine the existing `api keys required` and `dependencies required` decorators in the codebase, then refactor the listed modules to use them, ensuring error info is added.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65