用markyp html构建的bootstrap4组件
markyp-bootstrap4的Python项目详细描述
markyp-bootstrap4
引导程序4构建在markyp和markyp-html上的高阶组件。
安装
该项目列在python包索引中,只需执行pip install markyp-bootstrap4
即可安装。
开始
如果您不熟悉markyp
的基本概念,请首先查看它的文档here。
要演示markyp-bootstrap4
的功能,请转到项目的GitHub Pages。该页面的源代码是由demo.py
脚本生成的,您可以在该存储库的根目录中找到该脚本。
下面的示例演示如何使用markyp-bootstrap4
创建登录表单。
frommarkyp_htmlimportwebpagefrommarkyp_html.formsimportformfrommarkyp_bootstrap4importreqfrommarkyp_bootstrap4.layoutimportcontainer,one,col,margin,offsetfrommarkyp_bootstrap4.buttonsimportb_buttonfrommarkyp_bootstrap4.formsimportform_group,form_check,form_check_label,input_,textdeflogin():returnform(form_group(text.h5("Email"),input_.email(placeholder="Enter your email address")),form_group(text.h5("Password"),input_.password(placeholder="Enter your password")),form_check(input_.checkbox(),form_check_label("Remember Me"),class_=margin(bottom=2)),b_button.primary("Sign In",type="submit"))page=webpage(container(one(login(),md=6,class_=offset(md=3))),page_title="markyp-bootstrap4 example",head_elements=[req.bootstrap_css,*req.all_js])print(page)
下面是示例中要注意的事项列表:
- bootstrap 4的需求可以用
from markyp_bootstrap4 import req
导入,所需的css和javascript导入应该添加到网页的head_elements
。 layout
模块包含可用于定义网页布局的组件。markyp_bootstrap4
组件的分组方式与bootstrap 4文档中的组件相同。唯一的区别是每个模块名都是复数形式。
社区指南
一般来说,请相互尊重,并遵循以下准则与项目互动:
- 问题,反馈:使用
[Question] <issue-title>
标题打开问题。 - bug reports:打开一个带有
[Bug] <issue-title>
标题、对bug的充分描述的问题,并在可能的情况下复制该问题的代码片段。 - feature requests and ideas:打开一个带有
[Enhancement] <issue-title>
标题和增强建议的清晰描述的问题。
贡献指南
欢迎各种形式的贡献,包括文档改进、测试、错误修复和功能实现。
请遵循以下指导原则为项目做出贡献:
- 确保您的更改与项目的文档和编码样式匹配,包括PEP 484类型注释。
mypy
用于类型检查代码库,提交的代码不应产生类型错误。有关mypy
的详细信息,请参见this page。- small修复可以通过创建pull请求提交。
- 非平凡的更改应该在提交必须引用的问题跟踪程序中有一个关联的issue(通常通过在提交消息的末尾添加
#refs <issue-id>
)。 - 请为您所做的更改(如果适用)编写tests。
如果您对项目的贡献有任何疑问,请联系项目业主。
如contribution guidelines中所述,使用mypy
对项目进行类型检查,因此,首先,项目必须通过mypy
的静态代码分析。
该项目使用pytest
进行测试。选择的测试布局是测试在应用程序代码之外,请参见this page以了解它在实践中的含义。
如果安装了pytest
,则可以使用项目目录中的pytest test
命令执行测试集。
如果还安装了pytest-cov
,则可以通过从项目的根目录执行pytest test --cov markyp_bootstrap4
来生成测试覆盖率报告。
许可证-麻省理工学院
这个库是在mit license的条件下开源的。