create-onchain-agent


Namecreate-onchain-agent JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryCLI to create an onchain agent project
upload_time2025-03-07 22:44:47
maintainerNone
docs_urlNone
authorCarson Roscoe
requires_python>=3.10
licenseApache-2.0
keywords coinbase sdk crypto cdp agentkit ai agent
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # create-onchain-agent

## Overview

`create-onchain-agent` is a CLI tool powered by [AgentKit](https://github.com/coinbase/agentkit) that allows developers to quickly scaffold an **onchain agent** project. This tool simplifies the setup process by generating a chatbot with predefined configurations, including blockchain network selection and wallet providers.

## Requirements

To use `create-onchain-agent`, you must first setup:
- **Python**: [Install Python](https://realpython.com/installing-python/) version 3.10 or 3.11
- **Pipx**: [Install pipx](https://pipx.pypa.io/stable/installation/) using Python version 3.10 or 3.11

**NOTE:** If you have multiple versions of Python installed, you can specify the Python version when installing pipx.

e.g.:
```sh
python3.10 -m pip install --user pipx
python3.10 -m pipx ensurepath
```

## Usage

To use `create-onchain-agent`, simply run:

```sh
pipx run create-onchain-agent
```

This command will guide you through setting up an onchain agent project by prompting for necessary configuration options.

## Features

- **Guided setup**: Interactive prompts help configure the project.
- **Supports multiple blockchain networks**.
- **Select your preferred wallet provider**.
- **Automates environment setup**.

### Setup Process

The CLI will prompt you for the following details:

1. **Project Name**: The name of your new onchain agent project.
2. **Package Name**: The Python package name (auto-formatted if needed).
3. **Network**: Choose from available blockchain networks.
4. **Chain ID**: Specify if using a custom network.
5. **Wallet Provider**: Select a preferred method for wallet management.

After answering the prompts, the CLI will:

- Generate the project structure.
- Copy necessary template files.
- Configure the selected settings.
- Display next steps to get started.

## Getting Started

Once your project is created, navigate into the directory and install dependencies:

```sh
cd my-project
poetry install
```

Then, configure your environment variables:

```sh
mv .env.local .env
```

Run the chatbot:

```sh
poetry run python chatbot.py
```

## Documentation & Support

- **Docs:** [https://docs.cdp.coinbase.com/agentkit/docs/welcome](https://docs.cdp.coinbase.com/agentkit/docs/welcome)
- **GitHub Repo:** [http://github.com/coinbase/agentkit](http://github.com/coinbase/agentkit)
- **Community & Support:** [https://discord.gg/CDP](https://discord.gg/CDP)


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "create-onchain-agent",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "coinbase, sdk, crypto, cdp, agentkit, ai, agent",
    "author": "Carson Roscoe",
    "author_email": "carsonroscoe7@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/97/a2/fb7934644da44e934be414e6b81deb86e7c43e2ea541bbc73abec9b062c5/create_onchain_agent-0.2.0.tar.gz",
    "platform": null,
    "description": "# create-onchain-agent\n\n## Overview\n\n`create-onchain-agent` is a CLI tool powered by [AgentKit](https://github.com/coinbase/agentkit) that allows developers to quickly scaffold an **onchain agent** project. This tool simplifies the setup process by generating a chatbot with predefined configurations, including blockchain network selection and wallet providers.\n\n## Requirements\n\nTo use `create-onchain-agent`, you must first setup:\n- **Python**: [Install Python](https://realpython.com/installing-python/) version 3.10 or 3.11\n- **Pipx**: [Install pipx](https://pipx.pypa.io/stable/installation/) using Python version 3.10 or 3.11\n\n**NOTE:** If you have multiple versions of Python installed, you can specify the Python version when installing pipx.\n\ne.g.:\n```sh\npython3.10 -m pip install --user pipx\npython3.10 -m pipx ensurepath\n```\n\n## Usage\n\nTo use `create-onchain-agent`, simply run:\n\n```sh\npipx run create-onchain-agent\n```\n\nThis command will guide you through setting up an onchain agent project by prompting for necessary configuration options.\n\n## Features\n\n- **Guided setup**: Interactive prompts help configure the project.\n- **Supports multiple blockchain networks**.\n- **Select your preferred wallet provider**.\n- **Automates environment setup**.\n\n### Setup Process\n\nThe CLI will prompt you for the following details:\n\n1. **Project Name**: The name of your new onchain agent project.\n2. **Package Name**: The Python package name (auto-formatted if needed).\n3. **Network**: Choose from available blockchain networks.\n4. **Chain ID**: Specify if using a custom network.\n5. **Wallet Provider**: Select a preferred method for wallet management.\n\nAfter answering the prompts, the CLI will:\n\n- Generate the project structure.\n- Copy necessary template files.\n- Configure the selected settings.\n- Display next steps to get started.\n\n## Getting Started\n\nOnce your project is created, navigate into the directory and install dependencies:\n\n```sh\ncd my-project\npoetry install\n```\n\nThen, configure your environment variables:\n\n```sh\nmv .env.local .env\n```\n\nRun the chatbot:\n\n```sh\npoetry run python chatbot.py\n```\n\n## Documentation & Support\n\n- **Docs:** [https://docs.cdp.coinbase.com/agentkit/docs/welcome](https://docs.cdp.coinbase.com/agentkit/docs/welcome)\n- **GitHub Repo:** [http://github.com/coinbase/agentkit](http://github.com/coinbase/agentkit)\n- **Community & Support:** [https://discord.gg/CDP](https://discord.gg/CDP)\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "CLI to create an onchain agent project",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [
        "coinbase",
        " sdk",
        " crypto",
        " cdp",
        " agentkit",
        " ai",
        " agent"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f35922acd34fe4f973946d6e26b103e404377cf0d4a6ad688e1223cb187be218",
                "md5": "ab2dd32198c725162b44a1be83333160",
                "sha256": "c38ec6bfcb2a60c123e1f1ebec7d2b2bbb22ac682c1d4ee8c79b4133b4ff8752"
            },
            "downloads": -1,
            "filename": "create_onchain_agent-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ab2dd32198c725162b44a1be83333160",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 5923,
            "upload_time": "2025-03-07T22:44:47",
            "upload_time_iso_8601": "2025-03-07T22:44:47.055869Z",
            "url": "https://files.pythonhosted.org/packages/f3/59/22acd34fe4f973946d6e26b103e404377cf0d4a6ad688e1223cb187be218/create_onchain_agent-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "97a2fb7934644da44e934be414e6b81deb86e7c43e2ea541bbc73abec9b062c5",
                "md5": "e65b0bfd0e8ac75f538d05ec9b528fdc",
                "sha256": "28fc00d67a62e6fff19903b441625e8b77e8ad7ae98dcacd50c91cbbaa9ba464"
            },
            "downloads": -1,
            "filename": "create_onchain_agent-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e65b0bfd0e8ac75f538d05ec9b528fdc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 5446,
            "upload_time": "2025-03-07T22:44:47",
            "upload_time_iso_8601": "2025-03-07T22:44:47.895566Z",
            "url": "https://files.pythonhosted.org/packages/97/a2/fb7934644da44e934be414e6b81deb86e7c43e2ea541bbc73abec9b062c5/create_onchain_agent-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-07 22:44:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "create-onchain-agent"
}
        
Elapsed time: 0.43516s