1 Star 5 Fork 2

残阳如血 / PyCheer

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0
logo

一、前言

PyCheer是一个代码编辑器,基于flask,支持在浏览器端(不一定要在同一台机器上,但必须互相联网)访问,为只用终端而没有桌面环境的服务器提供代码编辑帮助。同时也支持 Markdown的编辑。

二、安装

请输入以下命令以安装:

pip install PyCheer

三、启动

进入对应目录后,请输入以下命令(二选一)启动:

pycheer run
python -m PyCheer run

此时,PyCheer会输出一行蓝色字体(部分终端不支持颜色),代表Token(在进入网页时需要使用),请复制下来。

使用浏览器访问:

http://localhost:1111

将Token粘贴进输入框里,即可开始使用PyCheer。

对于没有复制功能的终端,请输入以下命令启动:

pycheer run -b

其中 -b 参数代表“自动启动浏览器”。

如果1111端口已被占用或你想同时启动多个PyCheer,请加上 -p <端口> 参数以指定启动端口。

从PyCheer 1.2.8版本开始支持配置SSL以提高安全性。在启动时,您需要添加 -scrt <SSL certificate file>-skey <SSL private key file> 参数,参数内容分别为证书文件(后缀名应为crt,但也许pem也可以)和私钥文件(后缀名应为key)的路径。

四、基础使用

1、基本页面与操作

如图:

终端控制台界面

其中,蓝色字体为Token,绿色字体为网页地址。

然后再访问第一个网址,结果如图:

首页

此时,您可以查看当前目录下的文件。

也可以访问 localhost:<端口,默认为1111> ,然后在如图输入框中输入Token或解锁密码,点击“确定”。

锁定页面

点击一个文件夹可以进入这个文件夹,点击一个文件可以打开或编辑这个文件。

目前支持编辑的文件:

文件后缀 文件类型
.py Python 源文件
.html HTML 源文件
.js JavaScript 源文件
.css CSS 样式文件
.md Markdown 文件
.txt 文本文档
.c C语言源文件
.cpp C++语言源文件
.h C/C++语言头文件
.hpp C/C++语言头文件
.json JSON文件
.java Java语言源文件

支持查看(但不支持编辑)的文件:

文件后缀 文件类型
.png PNG 图像文件
.jpg JPG 图像文件
.jpeg JPEG 图像文件
.mp3 MP3 音频文件(播放时可能会有亿点点诡异)

对于其它类型的文件,则会根据设置打开。如果这恰好是二进制文件,就会报500 Internal Server Error错误。

2、退出

在右上角有一个“退出PyCheer”按钮,可以暂时退出(但不会关闭)PyCheer。再次输入Token或解锁密码即可再次进入PyCheer。

3、关闭

点击“关闭PyCheer”按钮即可关闭PyCheer服务。

4、编辑文件

点击支持编辑的文件,即可进入编辑页面。

编辑页面图片

如图,中间为代码编辑区,可以编辑代码。

下方为状态栏,指示当前状态。一旦代码被编辑,状态栏就会有所改变。

编辑完毕后,记得点击“保存”!

5、新建文件(夹)

在目录页面中点击“新建文件(夹)”按钮,即可新建文件(夹)。

6、重命名文件

点击目录页面中文件名右边的图标,即可进行重命名。

如果操作迟迟没有返回结果(比如,保存时状态栏一直显示“保存中,请稍后”),那多半就是出了BUG。一般情况下,您可以查看服务终端控制台或浏览器Console。

您也可以提交ISSUE,帮助我们修复此问题。

五、进阶使用:Git版本控制系统

从PyCheer 1.0.2版本开始支持Git版本控制系统。

需要注意,如果在启动PyCheer时出现如下输出:

Failed to introduce Git module. This may be because Git is not installed on your computer.
If you don't want to start Git using PyCheer, you can ignore this information.

则说明PyCheer引入Git时失败了,有可能是Git未安装,也有可能是其他原因。

如果PyCheer检测到启动目录下存在.git` 文件夹并且引入模块成功,则会在目录页面右上角显示“启动Git”按钮。点击即可启动Git。

如图:

Git版本控制系统

Git版本控制系统

1、暂存与提交:文件编辑信息

如果文件被编辑,使用 git status 命令即可查看。而信息框显示的,就是该命令的输出。

点击“刷新”可以刷新状态。

点击“将所有已编辑的文件移至暂存区”相当于执行 git add .

点击“提交”,即可提交文件。需要注意,暂不支持多行提交信息。此按钮相当于执行 git commit -m "<提交信息>"

2、本地分支:本地分支信息

这个板块显示与本地分支,绿底白字的为当前所在的分支,白底黑字的为可以切换的分支。

点击分支右边的“切换”图标即可切换分支。相当于执行 git checkout <分支名>

需要注意,在文件已编辑但未提交的情况下,不可以切换分支。

点击“在当前分支的基础上新建本地分支”,即可新建一个分支。注意,请确认当前所在的分支,再进行此操作。

3、远程仓库:远程分支信息

这个板块显示与远程仓库有关的信息。

这里显示了所有远程分支,相当于 git remote。每个远程分支有3个按钮,分别代表“推送”“拉取”“删除”。

比如,现在正在dev分支。

  • 点击origin旁边的第1个按钮“推送”,相当于执行 git push origin dev

  • 点击origin旁边的第2个按钮“拉取”,相当于执行 git pull origin dev

  • 点击origin旁边的第3个按钮“删除”,相当于执行 git remote remove origin

点击下方的“新建远程分支”可以连接到一个远程仓库,相当于执行 git remote add <远程分支名> <URL>

推送或拉取都需要一定的时间,请耐心等待。

部分操作系统暂时不支持账号密码登录。请在本机上配置好SSH,并将SSH公钥在Gitee或Github上设置好后,再使用推送/拉取功能。

似乎Windows在操作Git时会在本机弹出密码输入对话框。

六、进阶使用:系统语言

请参阅同目录下的LANGUAGE.md。

七、进阶使用:PyCheer主题

请参阅同目录下的PYCHEERTHEME.md。

八、设置

从PyCheer 1.0.8版本开始支持设置。

目前,设置支持:

  1. 编辑器样式。

  2. 解锁密码。

  3. 对于不支持的文本文件,采取何种方式打开?

  4. 系统语言。

  5. PyCheer主题。

九、花絮

1、文件图标总览

进入 seeicon 页面,您就可以看到所有支持的文件图标总览。如图:

文件图标总览

2、hello 页面

进入 hello 页面,您就可以查看到关于当前PyCheer运行的有关信息和关于PyCheer。

3、首页

直接输入:pycheer,不带任何参数,你就可以看到关于PyCheer的一些信息。

4、版本

输入 pycheer version 可以查看PyCheer的版本。

十、赞赏与贡献

如果您认为此项目不错,给个Star并赞赏一下呗~

您可以提交ISSUE以帮助我们修复问题,或提出改进建议。

您也可以将本项目克隆到本地,再进行修改后提交Pull Requests。

祝您使用愉快!

开源不易,赞赏一下呗~

赞赏码

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) 2020 cyrxdzj PyCheer is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) 2020 cyrxdzj PyCheer is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

一个可在浏览器里访问的代码编辑器,使用Python语言编写。该项目类似于jupyter,在服务端启动后在客户端浏览器中访问编辑页面。 展开 收起
Python 等 3 种语言
MulanPSL-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/cyrxdzj/PyCheer.git
git@gitee.com:cyrxdzj/PyCheer.git
cyrxdzj
PyCheer
PyCheer
master

搜索帮助