分类 git 下的文章

Archlinux AUR软件包上传

个人笔记,如有转载,请注明出处。

——by realasking

给AUR打好软件包后的上传过程如下:

1.本地测试

cd folder

makepkg

sudo pacman -U 软件包名.tar.xz

如果成功,即可上传

2.上传

git clone git+ssh://[email protected]/包名.git

包名要和PKGBUILD中的一致

cd 包名

cp ../* ./

makepkg --printsrcinfo > .SRCINFO

git add .

git commit -m 'release package'

git push --set-upstream origin master

3.更新包 

cd folder/包名

makepkg --printsrcinfo > .SRCINFO

git pull origin master

git add .

git commit -m 'update'

git push origin master

 

 

python工程的打包和发布

个人笔记,如有转载,请注明出处。

——by realasking

最近弄的essential-pathway是我第一次直接发布自己写的小程序,通过折腾这个东西,对纯python程序包的打包和发布有了一定的了解,故作个记录,备忘。

python程序打包的时候,要将库和执行脚本或程序分开放,同时还要有一些其它定义文件,从工程目录开始,按目录结构,其文件和放置顺序如下:

1.工程目录

此目录下要放置至少两个文件夹和若干文件,两个文件夹分别是bin和以库命名的文件夹(假定为A),其中bin/下放置可执行文件或脚本b,A下放置作为库的.py文件,此外还可以建立文件夹放置非代码的数据文件c等。

此目录下除文件夹之外的其它文件包括但不仅限于setup.py,MANIFEST.in,LICENSE,README.md,requirements.txt , changelog.md。

1-1 setup.py

setup.py应当包含形如以下一些内容:

#!/usr/bin/env python
from setuptools import setup, find_packages

with open('README.md') as buff:
longdes = buff.read()

with open('changelog.md') as buff:
longdes += buff.read()

CLASSIFIERS = [
'Programming Language :: Python :: 3',
'Topic :: Utilities',
'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
'Development Status :: 5 - Production/Stable',
]

setup(
name='工程名',
version='版本号',
keywords=['关键字1','关键字2'],
description='简单说明',
long_description=longdes,
author='realasking',
author_email='[email protected],[email protected]',
url='项目发布地址',
packages=find_packages(),
include_package_data=True,
install_requires=['在python中的依赖包'],
scripts=['bin/b'],
platforms=['linux','cygwin','freebsd','Unix'],
classifiers=CLASSIFIERS,
)

该文件中,setup()区域内,有很多参数都要求使用list,比如keywords,install_requires, scripts,platforms和classifiers等,不然可能会报不是对象的错误。

其中引用的README.md是说明文件,如果发布在github上,可以采用markdown格式;

changelog是程序更新历史文件,是一个简单的文本文件。

CLASSIFIERS的可选内容可以在pypi查到,根据需要选择即可,其中“License :: OSI Approved :: ”指代的协议内容可以到OSI 查询,无论使用哪个,应当将所选协议内容拷贝到LICENSE文件中,随软件包发布。

url的指向自己项目要发布的地方,可以先申请下来填在这里

scripts就是可执行文件的列表了,这里面的文件在安装时会安装到指定的程序运行路径中去,如果是脚本文件,只要文件中开头指定了正确的解释器,比如#!/bin/bash或#!/bin/env python之类,文件本身可以没有扩展名。如果要包含数据文件,最好不要在setup.py中设置,而是在MANIFEST.in文件中设置。

platforms是脚本可以支持的平台,可以在python文档 中查询。

如果有数据文件时,在MANIFEST.in中设置了数据文件的情况下,数据文件不能安装到系统中,则应该删除掉“include_package_data=True, ”这一行语句。

1-2 MANIFEST.in

这是用来包含杂项文件的一个文件定义,其内容类似下方定义:

include changelog.md  LICENSE README.md  requirements.txt
recursive-include bin *.*
recursive-include A *.*

如果要添加数据文件,可以将如下语句添加:

include 数据文件相对路径/数据文件

然后在python的脚本中使用数据文件时:

import os
this_dir, this_filename = os.path.split(__file__)
DATA_PATH = os.path.join(this_dir, "data", "data.txt")
print open(DATA_PATH).read()

此法来自于stackoverflow 。

1-3 requirements.txt

其中填写python依赖包,一行一个。

2.目录A下

包含至少如下文件:一个__init__.py文件,和若干.py结尾的python库(比如aa.py,bb.py,cc.py)的脚本文件

2-1 __init__.py形如以下所示:

#!/usr/bin/env python
__all__=["aa","bb","cc"]
from . import aa
from . import bb
from . import cc

__name__='项目名'
__version__ = '版本号'
__short_description__ = '短描述'
__author__ = 'realasking'
__author_email__ ='<[email protected],[email protected]>'
__license__ = '协议'

__all__是用于在程序调用库的时候使用from A import aa之类的用法而指定的,而from . import aa之类则是准许程序调用库时直接用import A导入整个库。

2-2库文件编写时的注意事项

以aa.py为例,如果其中定义了新的class,那么class应当使用aa以外的名字,否则在其它程序调用库中aa来产生一个实例的时候,就需要用:

import A

II=A.aa.aa()

这样的形式,若将class命名为ab,则清楚很多:

import A

II=A.aa.ab()

另外,一个文件中写多个class的时候,import 可以写在所有class开始定义之前,而若bb.py要调用aa.py中的class,则在bb的import段书写from A import aa之类的即可。

这一切都完成之后,就是打包发布了,python程序的发布,可以直接发布到pypi上,也可以先发布到一个代码托管平台,比如github,github平台上新建项目和发布方法可见git初步使用 ,也可以使用我做的一个简单脚本giteasy 。

3使用pypi

对于python的程序,即使在github上发布过,也最好提交到pypi上,这样能够通过pip之类的工具被人自动的获取和安装,pypi的使用和程序提交过程如下。

3-1注册

进入pypi首页 ,点击右边的register链接,输入用户名,密码和邮箱地址,然后到自己的邮箱中进行验证即可,如果需要使用pgp或gpg key,相关key需要先提交到公共服务器上,具体操作见阮一峰:GPG入门教程 。

3-2提交程序

python setup.py register

然后输入用户名和密码。

python setup.py sdist upload

即可。

另一个更安全的方法:

pip install twine

twine register dist/包名.whl

twine upload dist/*

至于详细的文献资料,python官方文档 就十分不错。

github使用初步

个人笔记,如有转载,请注明出处。

——by realasking

很久没有用github了,今天想用它备份点东西,于是又折腾了一下,现将操作过程作个记录,备忘。

1.修改邮箱

登录->头像->settings->Emails->Add email address->Add->Primary email address->save->用新邮箱验证

如此添加多个邮箱,但只设置一个为primary,然后:

Profile->Public Email

设置公开邮箱

2.SSH和GPG Key

先在本地检查有没有Key.

SSH是在$HOME/.ssh下看有没有id_rsa之类的文件,注意,同时要有id_rsa.pub,否则就用ssh-keygen重新生成:

ssh-keygen -t rsa -C "邮箱名作为备注" -f "输出私钥名"

GPG是看如下命令:

gpg --list-secret-keys --keyid-format LONG

若有sec,uid和ssb输出,则说明已经创建了GPG Key

GPG Key的生成方式见:阮一峰:GPG入门教程

我一直是用的ssh,由于已经有了key pairs,所以直接导入就行了。

依次执行以下命令:

ssh-agent bash

ssh-add ~/.ssh/id_rsa后缀

xclip -sel clip < ~/.ssh/id_rsa后缀.pub

然后在浏览器中:

SSH and GPG Keys->New ssh Key->拷贝到Key框中,再写个Title->Add SSH Key

3.在github上创建项目aaa并以空文件初始化

4.在本地创建项目的文件夹,假设名字是aaa_folder

5.执行以下命令初始化git

cd aaa_folder

git init

ssh -T [email protected]

cp 待上传文件 ./

git remote add origin [email protected]:用户名/aaa.git

git add .

git pull origin master

git commit -m "init project"

git push -u origin master

6.以后修改文件后的更新

git add .

git commit -m "comment"

git push origin master

7.创建分支和合并

创建分支

git checkout -b dev

git add 文件名

git commit -m "分支修改"

合并分支dev到master

git merge dev

git branch -d dev

8.查看和切换分支

查看所处分支

git branch

切换分支

git co 分支名