Giter VIP home page Giter VIP logo

song's Introduction

关于

利用readthedocs的Python技术文章的翻译和收集。

订阅

RSS: https://pyzh.readthedocs.org/en/latest/rss.xml

Online: https://pyzh.readthedocs.org/en/latest/

约定

  • 文件名必须是英文。一个文章的多个文件如下命名:

    xxxx-Part1.rst, xxxx-Part2.rst ..
  • 文第一行注明日期:

    :Date: 2013-04-15 22:00:00
  • 翻译的文章,需要注明原文链接

请Fork一起编写!

  1. 初始化环境:

    cd PyZh
    virtualenv venv
    pip install -r requirements.pip
  2. 编写文章:

    vim docs/xxxxx.rst
  3. 编译预览:

    cd docs
    make html
    python -m SimpleHTTPServer

    打开 http://localhost:8000 预览

  4. 更新Readthedocs文档:

    push上去到Github, 然后到https://readthedocs.org/projects/pyzh build下即可

RST

RST文档的语法: https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst

Example可以看项目中其它文章的源码

song's People

Contributors

lg6s avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

qin-glish

song's Issues

关于SQLAlchemy的一些tips

这是微信2群里有人问过的话题,起初是问怎么get all column name

SQLA分两块,一块ORM一块core,core负责SQL。一般用ORM就够了,但是core更直接(个人比较常用core

Ld2:Python变量命名规范

Ld2/py3/pep-1,简称LEP-1

c1. 类前缀:interface用大写I,节点/集合用大写N,abstract用大写A
c2. 类后缀:helper类/可选后缀H

c3. 实体类:可选前缀=E,后缀=

identifier/变量名:

i1. 用[此]代替[this]
i2. 无实义变量以字母v开头,如v1 v2 v3;常量以c开头
i3. 无实义函数以字母f开头;单目函数可用f1/fx,双目用f2/g,三目用f3/h/z
i4. 无实义参数中:参数间无顺序/可用XYZ,A/B可以表示左参数/右参数
i5. 业务逻辑函数/class method一律优先使用中文
i6. n,i/j/k表示数值参数,L,li表示List,t表示tuple,D/dic=dict,S->str->string
i7. 可以用[参]替代[argv],[参数]替代[args]

单字母规范补充:

a1. T=Type
a2. F=file /函数用小写f或fn替代
a3. C~=class /建议用cls替代
a4. b,~bin/bit;e,~element;g,~global;h,~head[t~tail] /~handle;
a5. N~number;o,~obj/对象/object;p,~ptr/指针/pointer;q~(ref:静态工作点
a6. 避免使用大写字母U / 为了和并集符号区分开来
a7. w~word;a/z~第一个/最后一个

其他常用缩写:

c> cls;r> ref;

// 其他想到再补充

todo:注释规范

# 注释一律优先使用中文
#>
##
###
####
#:
#=
#==
#=#
#?
#^
#~
#>>
#+
#1 
#`
#_#
#*
# //
#[1个空格]
#[2/3/4个空格]

label使用规则

  1. 如果标题里面还有label的字样,可以不加[比如标题有tacit,就可以不加tacit标签
  2. 数量不要太多,最多四个[参考人名,一般2到3个,四个字较少

群公告备份

论坛:https://github.com/pyzh/song/issues/1
中文编程:https://github.com/program-in-chinese
不撸兔子:github.com/bhuztez,b乎@6hu2t32

prev

s6R2[S6R1q群=523445644]
中文编程:https://github.com/program-in-chinese
不撸兔子:github.com/bhuztez,b乎@6hu2t32
esle: /secti6n,https://github.com/pyzh/song/issues/1

win7快捷方式配置规范

任务栏:常用
开始菜单:不太常用,系统组件,管理员身份运行
桌面:第三方,副本/chromium-user-data,较少用,较为私密/必要时可以隐藏桌面,国产常见毒瘤

论坛QA

大纲:

  • 微信群是干嘛的?跟论坛的关系?
  • 有没有共享空间?#有,q群+github
  • 本讨论组跟中文编程讨论组有什么关系? #没什么直接关系
  • 共同纲领 # 求同存异,实事求是,互相学习,交流进步
  • 其他想到再补充

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.