# oliver-codegen
oliver-codegen 是一款快速构建项目基础框架的脚手架工具. 其原理是从 Github 下载对应模板到本地, 并没有什么魔法代码.
## 安装
```bash
$ pipx install oliver-codegen
```
通常第一次使用 `pipx` 安装可执行程序时候, 可执行程序并没有自动添加到系统全局变量中, 导致在命令行无法使用. 这时候可以使用下面命令解决:
```bash
$ pipx ensurepath
```
## 使用方式
```bash
$ codegen create your_project_name -t python
```
其中 `-t` 后的参数是选择什么模板创建项目. 查看支持哪些模板命令 `codegen list template`
## 展示配置
输入以下命令, 将在控制台展示支持哪些模板.
```bash
$ codegen list template
```
## 更新程序
```bash
$ pipx upgrade oliver-codegen
```
如果你使用了国内镜像源, 可能存在同步问题, 无法更新到最新版本. 可以使用命令 `pipx upgrade oliver-codegen -i https://pypi.org/simple/`
## 卸载程序
```bash
$ pipx uninstall oliver-codegen
```
## 模板地址
```yaml
# 项目模板名称和存放地址映射表
template:
# Python 项目
# python 基本模板
python:
repository: "https://github.com/lifefossil/template-python.git"
# fastapi 模板
fastapi:
repository: "https://github.com/lifefossil/template-fastapi.git"
# pyside6 模板
pyside6:
repository: "https://github.com/lifefossil/template-pyside6.git"
# tkinter 模板
tkinter:
repository: "https://github.com/lifefossil/template-tkinter.git"
# Django + Tailwind 模板
django-tailwind:
repository: "https://github.com/lifefossil/template-django-tailwind.git"
# vue 项目
# vue-tailwindcss
vue-tailwindcss:
repository: "https://github.com/lifefossil/template-vue-tailwindcss.git"
# vue-element-plus
vue-element-plus:
repository: "https://github.com/lifefossil/template-vue-element-plus.git"
# vitepress
vitepress:
repository: "https://github.com/lifefossil/template-vitepress.git"
# electron 模板
electron:
repository: "https://github.com/lifefossil/template-electron.git"
```
Raw data
{
"_id": null,
"home_page": "https://github.com/lifefossil/oliver-codegen",
"name": "oliver-codegen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "codegen, oliver-codegen",
"author": "oliver",
"author_email": "lifefossil@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/01/92/010ba881a75471b7cdbcfa71be9146ed34d8254b5640305127b7861e428a/oliver_codegen-0.1.6.tar.gz",
"platform": null,
"description": "# oliver-codegen \noliver-codegen \u662f\u4e00\u6b3e\u5feb\u901f\u6784\u5efa\u9879\u76ee\u57fa\u7840\u6846\u67b6\u7684\u811a\u624b\u67b6\u5de5\u5177. \u5176\u539f\u7406\u662f\u4ece Github \u4e0b\u8f7d\u5bf9\u5e94\u6a21\u677f\u5230\u672c\u5730, \u5e76\u6ca1\u6709\u4ec0\u4e48\u9b54\u6cd5\u4ee3\u7801. \n\n\n## \u5b89\u88c5\n```bash\n$ pipx install oliver-codegen\n```\n\u901a\u5e38\u7b2c\u4e00\u6b21\u4f7f\u7528 `pipx` \u5b89\u88c5\u53ef\u6267\u884c\u7a0b\u5e8f\u65f6\u5019, \u53ef\u6267\u884c\u7a0b\u5e8f\u5e76\u6ca1\u6709\u81ea\u52a8\u6dfb\u52a0\u5230\u7cfb\u7edf\u5168\u5c40\u53d8\u91cf\u4e2d, \u5bfc\u81f4\u5728\u547d\u4ee4\u884c\u65e0\u6cd5\u4f7f\u7528. \u8fd9\u65f6\u5019\u53ef\u4ee5\u4f7f\u7528\u4e0b\u9762\u547d\u4ee4\u89e3\u51b3:\n```bash\n$ pipx ensurepath\n```\n\n## \u4f7f\u7528\u65b9\u5f0f\n```bash\n$ codegen create your_project_name -t python\n```\n\u5176\u4e2d `-t` \u540e\u7684\u53c2\u6570\u662f\u9009\u62e9\u4ec0\u4e48\u6a21\u677f\u521b\u5efa\u9879\u76ee. \u67e5\u770b\u652f\u6301\u54ea\u4e9b\u6a21\u677f\u547d\u4ee4 `codegen list template`\n\n\n## \u5c55\u793a\u914d\u7f6e\n\u8f93\u5165\u4ee5\u4e0b\u547d\u4ee4, \u5c06\u5728\u63a7\u5236\u53f0\u5c55\u793a\u652f\u6301\u54ea\u4e9b\u6a21\u677f.\n```bash\n$ codegen list template\n```\n\n\n## \u66f4\u65b0\u7a0b\u5e8f\n```bash\n$ pipx upgrade oliver-codegen\n```\n\u5982\u679c\u4f60\u4f7f\u7528\u4e86\u56fd\u5185\u955c\u50cf\u6e90, \u53ef\u80fd\u5b58\u5728\u540c\u6b65\u95ee\u9898, \u65e0\u6cd5\u66f4\u65b0\u5230\u6700\u65b0\u7248\u672c. \u53ef\u4ee5\u4f7f\u7528\u547d\u4ee4 `pipx upgrade oliver-codegen -i https://pypi.org/simple/`\n\n## \u5378\u8f7d\u7a0b\u5e8f\n```bash\n$ pipx uninstall oliver-codegen\n```\n\n## \u6a21\u677f\u5730\u5740\n```yaml\n# \u9879\u76ee\u6a21\u677f\u540d\u79f0\u548c\u5b58\u653e\u5730\u5740\u6620\u5c04\u8868\ntemplate:\n# Python \u9879\u76ee\n # python \u57fa\u672c\u6a21\u677f\n python:\n repository: \"https://github.com/lifefossil/template-python.git\"\n # fastapi \u6a21\u677f\n fastapi:\n repository: \"https://github.com/lifefossil/template-fastapi.git\"\n # pyside6 \u6a21\u677f\n pyside6:\n repository: \"https://github.com/lifefossil/template-pyside6.git\"\n # tkinter \u6a21\u677f\n tkinter:\n repository: \"https://github.com/lifefossil/template-tkinter.git\"\n # Django + Tailwind \u6a21\u677f\n django-tailwind:\n repository: \"https://github.com/lifefossil/template-django-tailwind.git\"\n\n# vue \u9879\u76ee\n # vue-tailwindcss\n vue-tailwindcss:\n repository: \"https://github.com/lifefossil/template-vue-tailwindcss.git\"\n # vue-element-plus\n vue-element-plus:\n repository: \"https://github.com/lifefossil/template-vue-element-plus.git\"\n # vitepress\n vitepress:\n repository: \"https://github.com/lifefossil/template-vitepress.git\"\n # electron \u6a21\u677f\n electron:\n repository: \"https://github.com/lifefossil/template-electron.git\"\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "\u9879\u76ee\u4ee3\u7801\u6846\u67b6\u5feb\u901f\u751f\u6210\u811a\u624b\u67b6",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/lifefossil/oliver-codegen",
"Repository": "https://github.com/lifefossil/oliver-codegen"
},
"split_keywords": [
"codegen",
" oliver-codegen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ff29b0e664558834216605710e554ba812f36cc5b26b9e74f99192d5f01ed230",
"md5": "70648981f6e48ea0c94149ecdbadf168",
"sha256": "82ec373126b51278dae7ab3b2a62253d5e864c739ad545380e0e1d02daeb56d8"
},
"downloads": -1,
"filename": "oliver_codegen-0.1.6-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "70648981f6e48ea0c94149ecdbadf168",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.11",
"size": 11562,
"upload_time": "2024-03-22T14:27:06",
"upload_time_iso_8601": "2024-03-22T14:27:06.331897Z",
"url": "https://files.pythonhosted.org/packages/ff/29/b0e664558834216605710e554ba812f36cc5b26b9e74f99192d5f01ed230/oliver_codegen-0.1.6-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0192010ba881a75471b7cdbcfa71be9146ed34d8254b5640305127b7861e428a",
"md5": "89562fa45520be07927db3e7bf6f882f",
"sha256": "ec9e3fba5a20cd68d930ffe400a0b3461477308fc75ea4090138fbf299558360"
},
"downloads": -1,
"filename": "oliver_codegen-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "89562fa45520be07927db3e7bf6f882f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9333,
"upload_time": "2024-03-22T14:27:08",
"upload_time_iso_8601": "2024-03-22T14:27:08.893642Z",
"url": "https://files.pythonhosted.org/packages/01/92/010ba881a75471b7cdbcfa71be9146ed34d8254b5640305127b7861e428a/oliver_codegen-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-22 14:27:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lifefossil",
"github_project": "oliver-codegen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "oliver-codegen"
}
JSON
