Python包开发的样板环境。
chthonic的Python项目详细描述
杂音的
Python包开发的样板环境。在
主要思想是让Vagrant处理大部分开销,从而使为PyPI开发包和打包它们变得尽可能轻松。在
由于我的很多工作都涉及数据科学,所以我也将Jupyter放入环境中(如下说明)。在
要求
VirtualBox和{a2}。在
环境设置
- 通过
sh replace_chthonic.sh <your-package-name>
将对虚拟包名的引用替换为您的包名。在 - 将任何包依赖项添加到
setup.py
和requirements.txt
。- 如果您决定在以后的开发过程中
pip install
新的依赖项,这一切都是好的!只需记住将它们添加到setup.py
和requirements.txt
。在
- 如果您决定在以后的开发过程中
- 使用
vagrant up
安装环境。在 - 使用
vagrant ssh
进入环境。- 要停止运行环境,请使用
exit
退出它,并用vagrant halt
停止它-这可以在不处理包时节省大量的CPU和内存。随时用vagrant up
再次提出。在
- 要停止运行环境,请使用
软件包开发
- 使用
vagrant ssh
进入环境。- 每次输入时,包的venv将自动激活。
- 默认情况下,此venv中已安装必要的打包工具。在
- 其他开发工具(例如,
pylint
)也默认安装;查看requirements.txt
查看完整列表。在
- 每次输入时,包的venv将自动激活。
- 将项目文件添加到适当的目录(例如,包子文件夹,在本例中其名称为
chthonic
)。在
PyPI包装
- 使用
vagrant ssh
进入流浪环境。在 - {17>确保你的包信息丰富。在
- 确保所有包依赖项都已添加到
setup.py
。在 python setup.py sdist
1twine upload dist/*
(需要一个PyPI帐户)。在- 完成了!在
与流浪汉一起使用Jupyter笔记本
- 使用
vagrant ssh
进入环境。在 - 在环境中,运行
jupyter notebook --ip=0.0.0.0
。在 - 将打印到控制台的最下面的URL复制到控制台(例如,
http://127.0.0.1:8888/?token=5dibo
(实际标记将是way,way,way longer))。在 - 打开您最喜欢的web浏览器,粘贴URL,然后转到它。在
1请注意,这并没有发出bdist_wheel
,这公然违反了the official packaging tutorial。我发现在游荡的环境中车轮构造有点缺陷,幸运的是,对我的项目来说是不必要的。如果你发现车轮的缺乏令人不安,那么你可能知道足够多的包装,不需要一个这样的环境首先。在
- 项目
标签: