探索pypi并以不寻常和有趣的方式将其内容可视化
pypixplore的Python项目详细描述
这个工具提供了探索python包(本地和远程)的有趣方法。这个包是作为 python教学练习。这不会降低我们对全功能工具的期望。请使用并报告任何错误 或者缺少特征。
使用:
pip install pypixplore
开始
这些说明将为您提供这个包的副本,并在您的本地机器上运行,以进行开发和测试。如果你想部署并参与项目,请继续阅读。
安装
让我们分步安装:
把项目交给你的帐户。
在计算机中选择存储项目的路径,转到它。
使用终端命令将刚刚完成的分叉克隆到此路径:
git clone https://github.com/YOUR-USERNAME/pypiexplorer
此时,您的计算机上应该有项目的最新版本的精确副本。
现在您必须安装此软件包的要求。打开项目根目录中的终端并键入:
pip install -r requirements.txt pip install -r test-requirements.txt
要确保一切正常,请使用以下命令运行测试:
python3 setup.py test
恭喜你!现在您的计算机中正在运行项目的版本。如果你想贡献和帮助建立这个令人难以置信的工具,继续阅读!
使用
安装后,您将获得一个名为ppx的命令行工具。您可以通过发出以下命令来学习如何使用它:
ppx -h usage: skeleton.py [-h] [--version] [-s NAME] [-l] [-r RELEASES] [-i INFO] [-p POPULARITY] [-v] [-vv] Copyright (C) 2017 Flavio C. Coelho This program comes with ABSOLUTELY NO WARRANTY; This is free software, and you are welcome to redistribute it under certain conditions; For details access: https://www.gnu.org/licenses/gpl-3.0.en.html Explore Python Package Index optional arguments: -h, --help show this help message and exit --version show program's version number and exit -s NAME, --status NAME Show Status for a given package. -l, --list List installed packages -r RELEASES, --releases RELEASES List package latest release -i INFO, --info INFO Shows package info -p POPULARITY, --popularity POPULARITY Return the popularity of a package as the number of recent downloads -v, --verbose set loglevel to INFO -vv, --very-verbose set loglevel to DEBUG
例如,如果要获取包的依赖关系树,可以:
ppx -t pypixplore pypixplore ╠═ asciitree ╠═ pipdeptree ║ ╚═ pip ╠═ pip ╠═ morfessor ╚═ tinydb note: only two levels shown.
贡献
为了对项目作出贡献,最好采取一些步骤。
首先,你应该决定为什么做贡献。您可以解决打开的问题或创建新问题。无论是哪种情况,请让仓库管理员把你分配给新的或现存的问题。
现在,在您的代码版本(即fork)上实现贡献。
之后,在tests文件夹中构建一些测试。这是一个重要的步骤:如果您不为您的贡献构建一个测试,它将不会被接受。
运行这些测试键入:
python3 setup.py test/TEST_FILE.py
。提示:确保运行的是主项目的最后一个版本。只需在终端上键入git pull fccoelho master。
现在,必须为函数或类编写docstring。按照这个template。
如果你很确定一切正常,那么就做一个请求。有人要去读书和考试。审核人批准后,您的稿件将被接受。
使用
构建- 这个项目是使用PyScaffold 2.5.7建立的。有关pyscaffold的详细信息和用法信息,请参见http://pyscaffold.readthedocs.org/