# Create Lilypad Module
Create Lilypad modules.
- [Build a Job Module](https://docs.lilypad.tech/lilypad/developer-resources/build-a-job-module) – How to build a Lilypad job module
- [JS CLI Wrapper](https://docs.lilypad.tech/lilypad/developer-resources/js-cli-wrapper-local) – How to run the Lilypad CLI wrapper locally
Create Lilypad Module works on macOS, Windows, and Linux.
If something doesn’t work, please [file an issue](https://github.com/DevlinRocha/create-lilypad-module/issues/new).
If you have questions or need help, please ask in [GitHub Discussions](https://github.com/DevlinRocha/create-lilypad-module/discussions).
## Quick Overview
To create a new Lilypad module, install our CLI tool:
```sh
pip install create-lilypad-module
```
If you've previously installed `create-lilypad-module`, you should to ensure that you're using the latest version:
```sh
pip install --upgrade create-lilypad-module
```
Now run `create-lilypad-module`:
```sh
create-lilypad-module
```
The CLI will ask for the name of your project. Alternatively, you can run:
```sh
create-lilypad-module project_name
cd project_name
```
Output:
```
project_name
├── config
│ └── constants.py
├── scripts
│ ├── docker_build.py
│ ├── download_models.py
│ └── run_module.py
├── src
│ └── run_inference.py
├── .dockerignore
├── .env
├── .gitignore
├── Dockerfile
├── lilypad_module.json.tmpl
├── README.md
└── requirements.txt
```
Raw data
{
"_id": null,
"home_page": null,
"name": "create-lilypad-module",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Devlin Rocha <devlin@devlinrocha.com>",
"keywords": "Lilypad, Lilypad Network, Lilypad module, module-generator, project-generator, boilerplate-generator, scaffolding-tool, project scaffolding, CLI",
"author": null,
"author_email": "Devlin Rocha <devlin@devlinrocha.com>",
"download_url": "https://files.pythonhosted.org/packages/60/ea/46b923cd35c3dfd2b4c8fff5a17e9209ac554ed1bb8c3e70e4cd821d65fe/create_lilypad_module-0.1.49.tar.gz",
"platform": null,
"description": "# Create Lilypad Module\n\nCreate Lilypad modules.\n\n- [Build a Job Module](https://docs.lilypad.tech/lilypad/developer-resources/build-a-job-module) \u2013 How to build a Lilypad job module\n- [JS CLI Wrapper](https://docs.lilypad.tech/lilypad/developer-resources/js-cli-wrapper-local) \u2013 How to run the Lilypad CLI wrapper locally\n\nCreate Lilypad Module works on macOS, Windows, and Linux.\n\nIf something doesn\u2019t work, please [file an issue](https://github.com/DevlinRocha/create-lilypad-module/issues/new).\n\nIf you have questions or need help, please ask in [GitHub Discussions](https://github.com/DevlinRocha/create-lilypad-module/discussions).\n\n## Quick Overview\n\nTo create a new Lilypad module, install our CLI tool:\n\n```sh\npip install create-lilypad-module\n```\n\nIf you've previously installed `create-lilypad-module`, you should to ensure that you're using the latest version:\n\n```sh\npip install --upgrade create-lilypad-module\n```\n\nNow run `create-lilypad-module`:\n\n```sh\ncreate-lilypad-module\n```\n\nThe CLI will ask for the name of your project. Alternatively, you can run:\n\n```sh\ncreate-lilypad-module project_name\ncd project_name\n```\n\nOutput:\n\n```\nproject_name\n\u251c\u2500\u2500 config\n\u2502 \u2514\u2500\u2500 constants.py\n\u251c\u2500\u2500 scripts\n\u2502 \u251c\u2500\u2500 docker_build.py\n\u2502 \u251c\u2500\u2500 download_models.py\n\u2502 \u2514\u2500\u2500 run_module.py\n\u251c\u2500\u2500 src\n\u2502 \u2514\u2500\u2500 run_inference.py\n\u251c\u2500\u2500 .dockerignore\n\u251c\u2500\u2500 .env\n\u251c\u2500\u2500 .gitignore\n\u251c\u2500\u2500 Dockerfile\n\u251c\u2500\u2500 lilypad_module.json.tmpl\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 requirements.txt\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Create Lilypad modules with a modern Docker setup, minimal configuration, and useful pre-written scripts.",
"version": "0.1.49",
"project_urls": {
"Bug Tracker": "https://github.com/DevlinRocha/create-lilypad-module/issues",
"Documentation": "https://github.com/DevlinRocha/create-lilypad-module#readme",
"Homepage": "https://github.com/DevlinRocha/create-lilypad-module",
"Source": "https://github.com/DevlinRocha/create-lilypad-module"
},
"split_keywords": [
"lilypad",
" lilypad network",
" lilypad module",
" module-generator",
" project-generator",
" boilerplate-generator",
" scaffolding-tool",
" project scaffolding",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d01ca0f519e56a58c180edb0524700787db5991693affdd1ea9bc799180f8de3",
"md5": "811cde85a74adfddf3bb2126bc1332c1",
"sha256": "25aaeb5e8a1a9f422296f1d54c72be7635417863c4b65da7c7347795eae6c467"
},
"downloads": -1,
"filename": "create_lilypad_module-0.1.49-py3-none-any.whl",
"has_sig": false,
"md5_digest": "811cde85a74adfddf3bb2126bc1332c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13904,
"upload_time": "2025-02-22T08:18:13",
"upload_time_iso_8601": "2025-02-22T08:18:13.819523Z",
"url": "https://files.pythonhosted.org/packages/d0/1c/a0f519e56a58c180edb0524700787db5991693affdd1ea9bc799180f8de3/create_lilypad_module-0.1.49-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "60ea46b923cd35c3dfd2b4c8fff5a17e9209ac554ed1bb8c3e70e4cd821d65fe",
"md5": "9b751019f961376f62cd97404de2f2bf",
"sha256": "a3302d9cfc01e327bddfc47a5f9f217885722d6ec6fe0d2a1b8dfff49ea2d39d"
},
"downloads": -1,
"filename": "create_lilypad_module-0.1.49.tar.gz",
"has_sig": false,
"md5_digest": "9b751019f961376f62cd97404de2f2bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10605,
"upload_time": "2025-02-22T08:18:15",
"upload_time_iso_8601": "2025-02-22T08:18:15.636267Z",
"url": "https://files.pythonhosted.org/packages/60/ea/46b923cd35c3dfd2b4c8fff5a17e9209ac554ed1bb8c3e70e4cd821d65fe/create_lilypad_module-0.1.49.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-22 08:18:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DevlinRocha",
"github_project": "create-lilypad-module",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "create-lilypad-module"
}
JSON
