From 1e84c76899493f2cf58784e54f3a032315748812 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 15:03:07 +0000 Subject: [PATCH 1/8] Use same command to build as docs repo --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1d78bbf502..0fd0adf4cf 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -35,6 +35,6 @@ jobs: pip install tomte[tox]==0.2.17 sudo npm install -g markdown-spellcheck - name: Generate Documentation - run: tox -e docs + run: mkdocs build --clean --strict - name: Check spelling run: tox -e spell-check From 7daae4920ae89ed20378043a7dc13ba75217cfbd Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 15:06:40 +0000 Subject: [PATCH 2/8] Fix links --- docs/advanced_reference/commands/index.md | 18 +++++++++--------- docs/configure_service/index.md | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/advanced_reference/commands/index.md b/docs/advanced_reference/commands/index.md index 7b0c79b02c..a8011e5def 100644 --- a/docs/advanced_reference/commands/index.md +++ b/docs/advanced_reference/commands/index.md @@ -7,49 +7,49 @@ This page provides a quick reference to commonly used CLI commands in the Open A ### autonomy analyse Analyse an agent service, including ABCI app specifications, docstrings, logs, and more. -[Detailed analyse documentation](./advanced_reference/commands/autonomy_analyse.md) +[Detailed analyse documentation](./autonomy_analyse.md) ### autonomy deploy Deploy an agent service using various deployment backends (Docker, Kubernetes, or localhost). -[Detailed deploy documentation](./advanced_reference/commands/autonomy_deploy.md) +[Detailed deploy documentation](./autonomy_deploy.md) ### autonomy develop Development tools for agent services. -[Detailed develop documentation](./advanced_reference/commands/autonomy_develop.md) +[Detailed develop documentation](./autonomy_develop.md) ### autonomy fetch Fetch an agent or service from a registry. -[Detailed fetch documentation](./advanced_reference/commands/autonomy_fetch.md) +[Detailed fetch documentation](./autonomy_fetch.md) ### autonomy mint Mint components and services on-chain. -[Detailed mint documentation](./advanced_reference/commands/autonomy_mint.md) +[Detailed mint documentation](./autonomy_mint.md) ### autonomy push-all Push all available packages to a registry. -[Detailed push-all documentation](./advanced_reference/commands/autonomy_push_all.md) +[Detailed push-all documentation](./autonomy_push_all.md) ### autonomy replay Replay tools for agent services. -[Detailed replay documentation](./advanced_reference/commands/autonomy_replay.md) +[Detailed replay documentation](./autonomy_replay.md) ### autonomy service Manage on-chain services. -[Detailed service documentation](./advanced_reference/commands/autonomy_service.md) +[Detailed service documentation](./autonomy_service.md) ## Additional Information - Most commands support the `--help` flag for detailed usage information - Commands that interact with blockchains typically require a key file - Many commands have additional options for customization and configuration -- See the [detailed command reference](./advanced_reference/commands/autonomy_analyse.md) for complete documentation of each command +- See the [detailed command reference](./autonomy_analyse.md) for complete documentation of each command ## Common Options diff --git a/docs/configure_service/index.md b/docs/configure_service/index.md index 5942247105..2fac85bb38 100644 --- a/docs/configure_service/index.md +++ b/docs/configure_service/index.md @@ -6,6 +6,6 @@ Here you will find: - [The service configuration file](./service_configuration_file.md): Learn how to set up and customize your service's configuration - [Configure access to external chains](./configure_access_external_chains.md): Guide for configuring your service to work with different blockchain networks - [On-chain deployment checklist](./on-chain_deployment_checklist.md): Requirements and steps for deploying your service on-chain -- [Analyze and test](./analyze_test.md): Tools and practices for testing and analyzing your service +- [Analyze and test](./analise_test.md): Tools and practices for testing and analyzing your service These guides will help you properly configure and validate your agent service for both development and production environments. \ No newline at end of file From 4cad10cb3ccd4909e7c1c156a2d48a65ab519592 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 16:35:47 +0000 Subject: [PATCH 3/8] Fix links on deploy_service page --- docs/guides/deploy_service.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guides/deploy_service.md b/docs/guides/deploy_service.md index 218183f621..699193ba87 100644 --- a/docs/guides/deploy_service.md +++ b/docs/guides/deploy_service.md @@ -45,7 +45,7 @@ We illustrate the full local deployment workflow using the `hello_world` service autonomy build-image #(1)! ``` - 1. Check out the [`autonomy build-image`](../../../advanced_reference/commands/autonomy_build-image) command documentation to learn more about its parameters and options. + 1. Check out the [`autonomy build-image`](../advanced_reference/commands/autonomy_build-image.md) command documentation to learn more about its parameters and options. After the command finishes, you can check that the image has been created by executing: @@ -158,7 +158,7 @@ We illustrate the full local deployment workflow using the `hello_world` service ``` 1. Delete previous deployments, if necessary. - 2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-build) command documentation to learn more about its parameters and options. + 2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-build) command documentation to learn more about its parameters and options. This will create a deployment environment within the `./abci_build_*` folder with the following structure: @@ -190,7 +190,7 @@ We illustrate the full local deployment workflow using the `hello_world` service ``` 1. Delete previous deployments, if necessary. - 2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-build) command documentation to learn more about its parameters and options. + 2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-build) command documentation to learn more about its parameters and options. This will create a deployment environment within the `./abci_build_*` folder with the following structure: @@ -218,7 +218,7 @@ We illustrate the full local deployment workflow using the `hello_world` service autonomy deploy run #(1)! ``` - 1. Check out the [`autonomy deploy run`](../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-run) command documentation to learn more about its parameters and options. + 1. Check out the [`autonomy deploy run`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-run) command documentation to learn more about its parameters and options. This will spawn in the local machine: @@ -359,7 +359,7 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS autonomy fetch --use-mode # (1)! ``` - 1. `--use-mode` indicates that the service is registered in the Mode network. Check out the [`autonomy fetch`](../../../advanced_reference/commands/autonomy_fetch) command documentation to learn more about its parameters and options. + 1. `--use-mode` indicates that the service is registered in the Mode network. Check out the [`autonomy fetch`](../advanced_reference/commands/autonomy_fetch.md) command documentation to learn more about its parameters and options. Fetch the service with the desired token ID on Mode network. @@ -370,7 +370,7 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS autonomy build-image --service-dir your_service/ # (2)! ``` - 2. Check out the [`autonomy build-image`](../../../advanced_reference/commands/autonomy_build-image) command documentation to learn more about its parameters and options. + 2. Check out the [`autonomy build-image`](../advanced_reference/commands/autonomy_build-image.md) command documentation to learn more about its parameters and options. This command builds the Docker runtime images for the agent defined in a service configuration file service.yaml. @@ -395,7 +395,7 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS autonomy deploy build path/to/keys.json --kubernetes # (3)! ``` - 3. Check out the [`autonomy deploy build`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-build) command documentation to learn more about its parameters and options. + 3. Check out the [`autonomy deploy build`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-build) command documentation to learn more about its parameters and options. 6. **Start the service.** Run the service: @@ -403,7 +403,7 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS autonomy deploy run # (4)! ``` - 4. Check out the [`autonomy deploy run`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-run) command documentation to learn more about its parameters and options. + 4. Check out the [`autonomy deploy run`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-run) command documentation to learn more about its parameters and options. Run a service deployment locally stored. From 1a1b744d73043af05ea921c04d61f564e434a754 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 16:39:36 +0000 Subject: [PATCH 4/8] Fix other links --- docs/guides/overview_of_the_development_process.md | 2 +- docs/guides/publish_fetch_packages.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/overview_of_the_development_process.md b/docs/guides/overview_of_the_development_process.md index c68f6498c3..3568a70caa 100644 --- a/docs/guides/overview_of_the_development_process.md +++ b/docs/guides/overview_of_the_development_process.md @@ -1,4 +1,4 @@ -The figure below presents the development process with {{open_autonomy}}: from the idea of an off-chain service to its deployment in production. If you have completed the [quick start guide](../quick_start) you have already navigated through a significant part of this process. +The figure below presents the development process with {{open_autonomy}}: from the idea of an off-chain service to its deployment in production. If you have completed the [quick start guide](./quick_start.md) you have already navigated through a significant part of this process.
![](../images/development_process.svg) diff --git a/docs/guides/publish_fetch_packages.md b/docs/guides/publish_fetch_packages.md index 52530c0f62..fc13d517cb 100644 --- a/docs/guides/publish_fetch_packages.md +++ b/docs/guides/publish_fetch_packages.md @@ -71,7 +71,7 @@ You can either: Regardless of the methodology that you choose to develop your packages, it is important that they are developed with a clear separation of concerns, so that they can be reused in other projects. ## How to tell the framework what registry to use -The `push`, `add`, `publish` and `fetch` commands use, by default, the registry specified when the framework was initiated (command `autonomy init`). See for example the [set up guide](./set_up#set-up), where we initialized the framework to use the default remote [IPFS](https://ipfs.io) registry. +The `push`, `add`, `publish` and `fetch` commands use, by default, the registry specified when the framework was initiated (command `autonomy init`). See for example the [set up guide](./set_up.md), where we initialized the framework to use the default remote [IPFS](https://ipfs.io) registry. Additionally, the framework configuration can be overridden per command by using the flags `--local` or `--remote` in any of the commands `push`, `add`, `publish` or `fetch`. From 27853bb34897e8940d911f9c4a99eb4aca5a14a1 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 16:51:07 +0000 Subject: [PATCH 5/8] Align workflow with docs repo --- .github/workflows/docs.yml | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0fd0adf4cf..b5cd1e6bc4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,9 +32,28 @@ jobs: sudo apt-get update --fix-missing sudo apt-get autoremove sudo apt-get autoclean - pip install tomte[tox]==0.2.17 + pip install tomte[tox]==0.2.2 + pip install poetry + poetry update + poetry install --no-root sudo npm install -g markdown-spellcheck - - name: Generate Documentation - run: mkdocs build --clean --strict - name: Check spelling run: tox -e spell-check + + - name: Check doc links + run: tox -e check-doc-links + + - name: markdownlint-cli2-action + uses: DavidAnson/markdownlint-cli2-action@v9.0.0 + with: + globs: /docs/*.md # optional, default is *.{md,markdown} + + - name: Generate Documentation + run: | + find . -name "mkdocs.yml" | xargs -L1 sed -i.snrbck "s/materialx.emoji.twemoji/material.extensions.emoji.twemoji/g" + find . -name "mkdocs.yml" | xargs -L1 sed -i.snrbck "s/materialx.emoji.to_svg/material.extensions.emoji.to_svg/g" + find . -name "*.snrbck" | xargs -L1 rm + + poetry run pip3 install mkdocs-material==9.4.10 mkdocs-material-extensions==1.3 + poetry run pip3 install setuptools + poetry run mkdocs build --clean From 724c2b8609c6ce39603430e2a4ae1cc26ac3f481 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 16:55:49 +0000 Subject: [PATCH 6/8] Adjust python version --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b5cd1e6bc4..a5d0f86413 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,7 +15,7 @@ jobs: strategy: matrix: os: [ubuntu-latest] - python-version: [3.8] + python-version: [3.10] timeout-minutes: 30 From 19e086d7619311950d7fdac2ede63ea1f7561ad5 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 17:00:37 +0000 Subject: [PATCH 7/8] Try fix python version --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a5d0f86413..1645611d2b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,7 +15,7 @@ jobs: strategy: matrix: os: [ubuntu-latest] - python-version: [3.10] + python-version: ['3.10'] timeout-minutes: 30 From 27840099ae40bffbef1eb8e13cecd34c51dcd9a0 Mon Sep 17 00:00:00 2001 From: nrosa-valory Date: Tue, 14 Jan 2025 17:20:07 +0000 Subject: [PATCH 8/8] Add tool.poetry section to pyproject to fix CI issues --- pyproject.toml | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 4618ca7559..b1ca422399 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,17 @@ +[tool.poetry] +name = "open-autonomy" +version = "0.1.0" +description = "Open Autonomy Framework" +authors = ["developer-valory "] +license = "Apache-2.0 license" + +[tool.poetry.dependencies] +python = "^3.10" +tomte = {extras = ["tox","docs"], version = "==0.2.15"} +mkdocs-monorepo-plugin = "^1.0.5" + +[tool.poetry.dev-dependencies] + [build-system] -requires = ["setuptools", "wheel"] +requires = ["setuptools", "wheel","poetry-core>=1.0.0"] build_backend = "setuptools.build_meta"