Working version for `validate` command CLI #152

maximilien · 2025-01-29T02:39:01Z

This PR when complete will fix issue #132

DRAFT because having issues with poetry dependencies
Adds the Python CLI strucure
Adds the validate command

Quick test is:

./beeAI validate ./tools/workflow_schema.json ./test/schema/simple_workflow.yml

TODO

solve the poetry issues (could be my machine)
fix any issue since could not run code fully
add test for validate command
add basic test for CLI

CC: @psschwei and @akihikokuroda if you can take a look. I'll keep looking at how to resolve poetry

…review comments

…ucture. Eventually fixes issue i-am-bee#132

planetf1 · 2025-01-29T08:49:26Z

What poetry issues do you have? @maximilien

Ensure you are using poetry version 2 or above
By default poetry will create a virtual environment outside the project tree. To work consistently with vscode etc I'd suggest poetry config settings.virtualenvs.in-project true (this is a user, not project, setting). This will result in a .venv in the project root (which is one level down from the github repo root).
Ensure you are in the bee-hive subdirectory when initially running these commands
Ensure poetry is installed globally, not just in a venv
I've only tested with python 3.12 . Our spec currently allows 3.11

beeAI

common/common.py

tools/cli/beeAI.py

planetf1

See comments above.

tools/cli/cli.py

planetf1 · 2025-01-29T14:42:10Z

You WILL have poetry issues if using v1, make sure you have v2 installed (it is on homebrew)

To add additional dependencies:

cd bee-hive (the directory containing pyproject.yaml)
poetry shell << you can then run anything within this, as it will pick up virtual config. Run in each new shell
poetry add docopt << I found you needed this
poetry add common << and this
poetry install << will install the dependencies needed

Hopefully this will allow you to get code working. When merged I can open a subsequent PR to refactor & create a new module definition (in essence this would just add another directory alongside bee_hive, perhaps called bee_cli, perhaps bee_tools - but to have it 'under' where the pyproject.toml is)

maximilien · 2025-01-29T16:16:22Z

You WILL have poetry issues if using v1, make sure you have v2 installed (it is on homebrew)

To add additional dependencies:

cd bee-hive (the directory containing pyproject.yaml)

poetry shell << you can then run anything within this, as it will pick up virtual config. Run in each new shell

poetry add docopt << I found you needed this

poetry add common << and this

poetry install << will install the dependencies needed

Hopefully this will allow you to get code working. When merged I can open a subsequent PR to refactor & create a new module definition (in essence this would just add another directory alongside bee_hive, perhaps called bee_cli, perhaps bee_tools - but to have it 'under' where the pyproject.toml is)

OK. Will be trying this today,. Thanks for the tips Nigel. Heading to the office and I have a different machine so will try a clean setup there and see how far I get.

…ow run CLI with: poetry run ./beeAI -h You can run the validate command with: poetry run ./beeAI validate ../tools/workflow_schema.json ../test/schema/simple_workflow.yml

maximilien · 2025-01-30T00:20:58Z

@planetf1 this works now. Please check and give a review. Only thing missing are some tests but you can try the validate command with:

poetry run ./beeAI validate ../tools/workflow_schema.json ../test/schema/simple_workflow.yml

Assuming you are in thebee-hive/bee-hive directory. If this works let's merge as I can backfill missing test when I add the other commands.

Thanks for your suggestions and reviews.

CC: @psschwei @akihikokuroda

psschwei

Needs a rebase

Also, I got a number of syntax warnings for invalid escape sequence:

/.../python3.12/site-packages/docopt.py:165: SyntaxWarning: invalid escape sequence '\S'
  name = re.findall('(<\S*?>)', source)[0]
/.../python3.12/site-packages/docopt.py:166: SyntaxWarning: invalid escape sequence '\['
  value = re.findall('\[default: (.*)\]', source, flags=re.I)
/.../python3.12/site-packages/docopt.py:207: SyntaxWarning: invalid escape sequence '\['
  matched = re.findall('\[default: (.*)\]', description, flags=re.I)
/.../python3.12/site-packages/docopt.py:456: SyntaxWarning: invalid escape sequence '\S'

planetf1 · 2025-01-30T14:00:06Z

@maximilien same comments as Paul - rebase + also get invalid escape sequences.
glad to see poetry works

maximilien · 2025-01-30T14:13:49Z

/.../python3.12/site-packages/docopt.py:165: SyntaxWarning: invalid escape sequence '\S'
  name = re.findall('(<\S*?>)', source)[0]
...

I saw as well. I think this are issues with the doctopt depencies. I open issue #160

maximilien · 2025-01-30T15:04:56Z

@planetf1 solved all conflict and supress warnings for doctopt to move forward and will have solution in #160 in future. Please review and if all OK then merge.

NOTE: the checks are failing because I removed bee-hive/poetry.lock so that can be ignored

.gitignore

planetf1 · 2025-01-30T15:06:39Z

.gitignore

@@ -105,7 +105,7 @@ ipython_config.py
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock


this shouldn't make any difference (as per https://git-scm.com/docs/gitignore). A filename will apply at any level below. The file also appears lower down (which may be a dup)

planetf1 · 2025-01-30T15:08:08Z

bee-hive/pyproject.toml

@@ -11,6 +11,8 @@ python = ">= 3.11, < 3.13"
 pyyaml = "^6.0.2"
 openai = "^1.56.2"
 python-dotenv = "^1.0.1"
+docopt = "^0.6.2"


See #160 - optional to do here in in a new PR (fix is to use docopt-ng)

planetf1 · 2025-01-30T15:09:51Z

bee-hive/poetry.lock

@@ -0,0 +1,780 @@
+# This file is automatically @generated by Poetry 2.0.1 and should not be changed by hand.


I recommend removing this file from the PR. This needs to be explicit since it already forms part of the PR. Including means running poetry lock often & impacting CI tests (including it helps with reproducible builds, but I don't feel that's needed at this point)

this will fix the test failure - other comments can be handled in additional issues/prs as needed

psschwei

git rm bee-hive/bee-hive/poetry.lock but otherwise LGTM

maximilien · 2025-01-30T15:19:33Z

@planetf1 give me the OK to merge since #160 is tracking other issues with docopt

Assuming you are set with code. Will backfill tests with I work on #113 #114 and #115

Thanks.

maximilien · 2025-01-30T15:57:14Z

git rm bee-hive/bee-hive/poetry.lock but otherwise LGTM

Check now.

maximilien

Wonder if this is needed or should be added to gitignore? @planetf1 @psschwei

planetf1

Works fine for me now. thanks!

planetf1 · 2025-01-30T16:03:26Z

@psschwei I don't see there's any further removal needed now
@maximilien There's already a .gitignore for poetry.lock (which applies to all subdirectories)

planetf1 · 2025-01-30T16:02:13Z

bee-hive/.python-version

@@ -0,0 +1 @@
+3.12.8


is this needed
(optional to tidy up - or can be later PR)
Comes from pyenv?

maximilien · 2025-01-30T16:11:35Z

Ok let's merge. I was referring to: bee-hive/.python-version

planetf1 · 2025-01-30T16:20:21Z

Ok let's merge. I was referring to: bee-hive/.python-version

Ah right, in that case, yes in another pr will need to remove, as well as add to .gitignore (can be just .python-version)

maximilien and others added 13 commits January 22, 2025 15:42

first version of the JSON schema. Fixes issue i-am-bee#27

b0a7be7

Merge branch 'i-am-bee:main' into main

a35bc9c

addressing feedback from review

e287d40

addressed steps and agents definition

8b230b6

made agents also array

91776e2

first version of the agent schema that validares the agents used in POC0

be36a00

Merge branch 'i-am-bee:main' into main

2626728

added code section

39cf195

included suggestions and changes from @akihikokuroda's PR i-am-bee#139 …

876f97c

…review comments

Merge branch 'i-am-bee:main' into main

a9b2597

Merge branch 'i-am-bee:main' into main

286bbc5

Merge branch 'i-am-bee:main' into main

a452398

[DRAFT] first PR for validate command and includes the Python CLI str…

b5d0f8d

…ucture. Eventually fixes issue i-am-bee#132

maximilien requested review from akihikokuroda and psschwei January 29, 2025 02:39

maximilien self-assigned this Jan 29, 2025

maximilien added the hive Multiagent orchestration label Jan 29, 2025

fix correct CLI python file

a726ca0

planetf1 reviewed Jan 29, 2025

View reviewed changes

beeAI Outdated Show resolved Hide resolved

common/common.py Outdated Show resolved Hide resolved

tools/cli/beeAI.py Show resolved Hide resolved

planetf1 reviewed Jan 29, 2025

View reviewed changes

tools/cli/cli.py Outdated Show resolved Hide resolved

planetf1 mentioned this pull request Jan 29, 2025

Create new module for cli #156

Open

maximilien added this to the POC1 milestone Jan 29, 2025

maximilien linked an issue Jan 29, 2025 that may be closed by this pull request

CLI "validate" function for workflows #132

Closed

fix all the peotry issues by moving code to bee-hive cli directory. N…

7e52f77

…ow run CLI with: poetry run ./beeAI -h You can run the validate command with: poetry run ./beeAI validate ../tools/workflow_schema.json ../test/schema/simple_workflow.yml

maximilien changed the title ~~[DRAFT] first upload for validate command CLI~~ Working version for validate command CLI Jan 30, 2025

psschwei reviewed Jan 30, 2025

View reviewed changes

psschwei removed this from the POC1 milestone Jan 30, 2025

maximilien added 4 commits January 30, 2025 06:43

supress doctopt warnings and ignore bee-hive/poetry.lock

d5e1c39

resolved conflict

ff791f9

Merge branch 'maximilien-issue132'

d3befae

resolved conflicts ...

7fb7dbe

psschwei reviewed Jan 30, 2025

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

psschwei mentioned this pull request Jan 30, 2025

dedupe gitignore poetry.lock entry #161

Closed

planetf1 requested changes Jan 30, 2025

View reviewed changes

psschwei reviewed Jan 30, 2025

View reviewed changes

maximilien added 2 commits January 30, 2025 07:13

moving to docopt-ng

2078464

removing bee-hive/poetry.lock

9f709f8

maximilien force-pushed the issue132 branch from fef9b4e to 9f709f8 Compare January 30, 2025 15:15

maximilien commented Jan 30, 2025

View reviewed changes

planetf1 approved these changes Jan 30, 2025

View reviewed changes

planetf1 reviewed Jan 30, 2025

View reviewed changes

maximilien merged commit 4981b7b into i-am-bee:main Jan 30, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Working version for `validate` command CLI #152

Working version for `validate` command CLI #152

maximilien commented Jan 29, 2025 •

edited

Loading

planetf1 commented Jan 29, 2025

planetf1 left a comment

planetf1 commented Jan 29, 2025 •

edited

Loading

maximilien commented Jan 29, 2025

maximilien commented Jan 30, 2025

psschwei left a comment •

edited

Loading

planetf1 commented Jan 30, 2025

maximilien commented Jan 30, 2025

maximilien commented Jan 30, 2025

planetf1 Jan 30, 2025

planetf1 Jan 30, 2025

planetf1 Jan 30, 2025

planetf1 Jan 30, 2025

psschwei left a comment

maximilien commented Jan 30, 2025

maximilien commented Jan 30, 2025

maximilien left a comment

planetf1 left a comment

planetf1 commented Jan 30, 2025

planetf1 Jan 30, 2025 •

edited

Loading

maximilien commented Jan 30, 2025

planetf1 commented Jan 30, 2025

		@@ -0,0 +1,780 @@
		# This file is automatically @generated by Poetry 2.0.1 and should not be changed by hand.

		@@ -0,0 +1 @@
		3.12.8

Working version for validate command CLI #152

Working version for validate command CLI #152

Conversation

maximilien commented Jan 29, 2025 • edited Loading

planetf1 commented Jan 29, 2025

planetf1 left a comment

Choose a reason for hiding this comment

planetf1 commented Jan 29, 2025 • edited Loading

maximilien commented Jan 29, 2025

maximilien commented Jan 30, 2025

psschwei left a comment • edited Loading

Choose a reason for hiding this comment

planetf1 commented Jan 30, 2025

maximilien commented Jan 30, 2025

maximilien commented Jan 30, 2025

planetf1 Jan 30, 2025

Choose a reason for hiding this comment

planetf1 Jan 30, 2025

Choose a reason for hiding this comment

planetf1 Jan 30, 2025

Choose a reason for hiding this comment

planetf1 Jan 30, 2025

Choose a reason for hiding this comment

psschwei left a comment

Choose a reason for hiding this comment

maximilien commented Jan 30, 2025

maximilien commented Jan 30, 2025

maximilien left a comment

Choose a reason for hiding this comment

planetf1 left a comment

Choose a reason for hiding this comment

planetf1 commented Jan 30, 2025

planetf1 Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

maximilien commented Jan 30, 2025

planetf1 commented Jan 30, 2025

Working version for `validate` command CLI #152

Working version for `validate` command CLI #152

maximilien commented Jan 29, 2025 •

edited

Loading

planetf1 commented Jan 29, 2025 •

edited

Loading

psschwei left a comment •

edited

Loading

planetf1 Jan 30, 2025 •

edited

Loading