<div align="center">
<br>
<img width="640" src="https://raw.githubusercontent.com/frederick-wang/jianmu/main/docs/images/jianmu-preview-without-border.png" alt="Jianmu Framework">
<br>
<br>
</div>
<p align="center" color="#262626">
A simple desktop app development framework combining Python, Vue.js, Element Plus and Electron.
</p>
<p align="center">
<img src="https://img.shields.io/pypi/pyversions/Jianmu" alt="pyversions"> <img src="https://img.shields.io/pypi/v/Jianmu" alt="version"> <img src="https://img.shields.io/pypi/l/Jianmu" alt="license"> <img src="https://img.shields.io/github/last-commit/frederick-wang/jianmu" alt="last-commit"> <img src="https://img.shields.io/github/commit-activity/m/frederick-wang/jianmu" alt="commit-activity">
</p>
## Installation
### Python Version
We recommend using the latest version of Python. Jianmu supports Python 3.6 and newer.
### Install Jianmu
To install the [Jianmu package](https://pypi.org/project/Jianmu/), use the following command:
```sh
python -m pip install jianmu -U
```
Jianmu is now installed. After installation, you will have access to the `jianmu` binary in your command line. You can verify that it is properly installed by simply running `jianmu` command or `python -m jianmu`, which should present you with a help message listing all available commands.
You can check you have the right version with this command:
```sh
jianmu --version
```
## Usage
To create a new project, run:
```sh
jianmu create <project-name>
```
To upgrade the template of your project, navigate to the project directory and run:
```sh
jianmu upgrade
```
To run your application in development mode, navigate to your project directory and run:
```sh
jianmu dev
```
To run your application in production mode, navigate to your project directory and run:
```sh
jianmu start
```
To build your application for a software release, navigate to your project directory and run:
```sh
jianmu build
```
To clean runtime temporary files in project directory, navigate to your project directory and run:
```sh
jianmu clean
```
## Screenshots
<p align="center">
<br>
<img width="640" src="https://raw.githubusercontent.com/frederick-wang/jianmu/main/docs/images/ui_screenshot.png" alt="Jianmu UI Screenshot" style="box-shadow: 0px 0px 12px rgba(0, 0, 0, .12);">
<br>
<br>
<img width="640" src="https://raw.githubusercontent.com/frederick-wang/jianmu/main/docs/images/console_screenshot.png" alt="Jianmu Console Screenshot" style="box-shadow: 0px 0px 12px rgba(0, 0, 0, .12);">
<br>
<br>
</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/frederick-wang/jianmu",
"name": "Jianmu",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Zhaoji Wang",
"author_email": "hwoam@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/32/6c/cc29d8ce76d2a42aab3833be6f796679b7dedfeff67d55cb6c34c92cf522/Jianmu-0.0.12.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<br>\n<img width=\"640\" src=\"https://raw.githubusercontent.com/frederick-wang/jianmu/main/docs/images/jianmu-preview-without-border.png\" alt=\"Jianmu Framework\">\n<br>\n<br>\n</div>\n\n<p align=\"center\" color=\"#262626\">\nA simple desktop app development framework combining Python, Vue.js, Element Plus and Electron.\n</p>\n\n\n<p align=\"center\">\n<img src=\"https://img.shields.io/pypi/pyversions/Jianmu\" alt=\"pyversions\"> <img src=\"https://img.shields.io/pypi/v/Jianmu\" alt=\"version\"> <img src=\"https://img.shields.io/pypi/l/Jianmu\" alt=\"license\"> <img src=\"https://img.shields.io/github/last-commit/frederick-wang/jianmu\" alt=\"last-commit\"> <img src=\"https://img.shields.io/github/commit-activity/m/frederick-wang/jianmu\" alt=\"commit-activity\">\n</p>\n\n## Installation\n\n### Python Version\n\nWe recommend using the latest version of Python. Jianmu supports Python 3.6 and newer.\n\n### Install Jianmu\n\nTo install the [Jianmu package](https://pypi.org/project/Jianmu/), use the following command:\n\n```sh\npython -m pip install jianmu -U\n```\n\nJianmu is now installed. After installation, you will have access to the `jianmu` binary in your command line. You can verify that it is properly installed by simply running `jianmu` command or `python -m jianmu`, which should present you with a help message listing all available commands.\n\nYou can check you have the right version with this command:\n\n```sh\njianmu --version\n```\n\n## Usage\n\nTo create a new project, run:\n\n```sh\njianmu create <project-name>\n```\n\nTo upgrade the template of your project, navigate to the project directory and run:\n\n```sh\njianmu upgrade\n```\n\nTo run your application in development mode, navigate to your project directory and run:\n\n```sh\njianmu dev\n```\n\nTo run your application in production mode, navigate to your project directory and run:\n\n```sh\njianmu start\n```\n\nTo build your application for a software release, navigate to your project directory and run:\n\n```sh\njianmu build\n```\n\nTo clean runtime temporary files in project directory, navigate to your project directory and run:\n\n```sh\njianmu clean\n```\n\n## Screenshots\n\n<p align=\"center\">\n<br>\n<img width=\"640\" src=\"https://raw.githubusercontent.com/frederick-wang/jianmu/main/docs/images/ui_screenshot.png\" alt=\"Jianmu UI Screenshot\" style=\"box-shadow: 0px 0px 12px rgba(0, 0, 0, .12);\">\n<br>\n<br>\n<img width=\"640\" src=\"https://raw.githubusercontent.com/frederick-wang/jianmu/main/docs/images/console_screenshot.png\" alt=\"Jianmu Console Screenshot\" style=\"box-shadow: 0px 0px 12px rgba(0, 0, 0, .12);\">\n<br>\n<br>\n</p>\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple desktop app development framework combining Python, Vue.js, Element Plus and Electron.",
"version": "0.0.12",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47e1e03e827e767fd914ecc30d0612050346f4390068b18457cb544c2c597ace",
"md5": "b753be31edd6136e2f9e3c43849291b2",
"sha256": "e123281ad71c82c7569e1d99a3f7d49df1ea53551bf2049671ee319326c77d21"
},
"downloads": -1,
"filename": "Jianmu-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b753be31edd6136e2f9e3c43849291b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17894,
"upload_time": "2023-02-04T22:12:39",
"upload_time_iso_8601": "2023-02-04T22:12:39.751035Z",
"url": "https://files.pythonhosted.org/packages/47/e1/e03e827e767fd914ecc30d0612050346f4390068b18457cb544c2c597ace/Jianmu-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "326ccc29d8ce76d2a42aab3833be6f796679b7dedfeff67d55cb6c34c92cf522",
"md5": "d399831bee28aa7139e5fbb4a4e5dffb",
"sha256": "5e5e5b09816ee5eb290d51e3ece6bb9d8dbf368c6634f572cbe6b021f1732e10"
},
"downloads": -1,
"filename": "Jianmu-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "d399831bee28aa7139e5fbb4a4e5dffb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 13901,
"upload_time": "2023-02-04T22:12:41",
"upload_time_iso_8601": "2023-02-04T22:12:41.479483Z",
"url": "https://files.pythonhosted.org/packages/32/6c/cc29d8ce76d2a42aab3833be6f796679b7dedfeff67d55cb6c34c92cf522/Jianmu-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-04 22:12:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "frederick-wang",
"github_project": "jianmu",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "flask",
"specs": []
},
{
"name": "flask-socketio",
"specs": []
},
{
"name": "gevent",
"specs": []
},
{
"name": "gevent-websocket",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "rich",
"specs": []
},
{
"name": "pyreactivity",
"specs": []
},
{
"name": "dataclasses",
"specs": []
}
],
"lcname": "jianmu"
}
JSON
