search

i-am-bee / bee-community-tools

Additional tools for the Bee Agent Framework
https://i-am-bee.github.io/bee-agent-framework/#/tools
Apache License 2.0
10 stars 2 forks source link

Refactor directory structure #15

Open akihikokuroda opened 3 weeks ago

akihikokuroda commented 3 weeks ago

Which issue(s) does this pull-request address?

14 This is the first proposal.

Closes: #14

Description

Restructure directories to contain most of changes in one tool under one directory

Checklist

grahamwhiteuk commented 3 weeks ago

@akihikokuroda is this still WIP?

akihikokuroda commented 3 weeks ago

It's ready for review and comments. I'll take out WIP, Thanks!

grahamwhiteuk commented 3 weeks ago

Great, thanks. Could you rebase to main? I've just updated the core dependencies across the project.

grahamwhiteuk commented 3 weeks ago

Thanks. Could you also go through the PR check list and tick off the items you're able to.

akihikokuroda commented 3 weeks ago

E2e tests work except tests that require API key.

grahamwhiteuk commented 3 weeks ago

No probs, I'll check those out as part of my review - many thanks for your contribution!

grahamwhiteuk commented 1 week ago

This PR looks a bit muddled to me as it stands right now. I would recommend the following changes:

Re-instate Global Examples The examples are intended to show the creation of agents using the tools. Some examples may be specific to an individual tool such as that for Airtable where specific information is required to configure it. Some other examples are generic across multiple tools such as that for ImageDescription and OpenLibrary. This move also makes it unclear what would be run from the default "start" command in package.json.

Re-instate a default agent Setting the start script to tsx is not what I would expect as a user. The default start script should run an example agent that requires no further configuration from the user.

Don't exclude tests All tests should be run. Some tests have been excluded in package.json

Locate all tests under the tests subdir It's confusing to have only e2e tests located under the tests subdir and not the unit tests

Dont use @ imports There is a specific tsconfig set up such that imports can be namespaced as bee-community-tools similar to the way the library would be used in the wild.

akihikokuroda commented 1 week ago

@grahamwhiteuk Thanks for review. I believe that all comments have been addressed.