Kotti软件 -- 为您的网站添加软件项目列表
项目描述
这是Kotti CMS的一个扩展,它添加了一个在您的网站上展示软件项目列表的系统。
设置kotti_software
此插件为您的Kotti网站添加了两种新的内容类型。要设置内容类型,请将kotti_software.kotti_configure添加到ini文件中的kotti.configurators设置
kotti.configurators = kotti_software.kotti_configure
现在您可以创建一个软件集合并添加软件项目。
有不同的设置来调整软件的行为。
您可以选择在集合概览中是否要对软件项目进行分批处理。如果将kotti_software.collection_settings.use_batching设置为true(默认值),则软件项目将在单独的页面上显示。如果将其设置为false,则所有软件项目将全部在一个页面上显示
kotti_software.collection_settings.use_batching = false
如果您使用分批处理,您可以选择每页显示多少个软件项目。默认值kotti_software.collection_settings.pagesize为5
kotti_software.collection_settings.pagesize = 10
您可以使用自动分批处理,在滚动概览页时自动加载软件项目的下一页,而不是显示切换页面的链接。默认值kotti_software.collection_settings.use_auto_batching为true
kotti_software.collection_settings.use_auto_batching = false
使用 kotti_software.collection_settings.link_headline_overview,您可以控制收藏夹概览中软件项目标题是否链接到软件项目。此设置默认为 true
kotti_software.collection_settings.link_headline_overview = false
可以使用 kotti_software.asset_overrides 设置来覆盖 kotti_software 的一些部分。请查看有关 Kotti 的资产覆盖设置文档,这与 kotti_software 中的设置相同。
警告:此插件处于 alpha 版本。请在自己的风险下使用。
使用 kotti_software
将软件收藏夹添加到您的网站,然后向其中添加软件项目。以下是输入软件项目的方法
仅输入 PyPI JSON URL
输入 PyPI JSON URL,以及 GitHub 仓库信息以获取 GitHub 仓库信息,例如最新推送日期和时间,或者对 Bitbucket 仓库执行相同操作(您可以对具有 GitHub 和 Bitbucket 仓库的项目同时进行这两项操作)。
仅输入 GitHub 仓库信息或 Bitbucket 信息,用于仅包含仓库的软件项目。
输入标题、描述、日期以及以下任一项:home_page、docs_url、package_url、bugtrack_url(手动输入),并指定这些值不应从 PyPI 的值中覆盖,如果存在这些值。
仅输入日期(基本输入,仅包含日期、标题、描述和您希望在正文中输入的内容 – 对已停用的项目很有用)。将日期处理选择设置为使用输入的值。
应根据上述使用情况以及输入的值是否要使用,还是从 PyPI、GitHub 或 Bitbucket 获取值来设置日期处理和描述处理选择属性。
还有布尔覆盖属性,用于使用手动输入的 home_page、docs_url、package_url 和 bugtrack_url 的组合以及从 PyPI 获取这些值。
JSON 源的说明
PyPI
输入以下格式的 URL:“http://pypi.python.org/pypi/{项目名称}/json”,其中 {项目名称} 是 PyPI 上项目的敏感名称。例如,对于 Kotti,URL 是“http://pypi.python.org/pypi/Kotti/json”。
请参阅 http://pypi.python.org/pypi/Kotti/json 以查看解析的 JSON。
GitHub
输入 GitHub 拥有者和仓库,这将用于构建形式为:https://api.github.com/repos/{拥有者}/{仓库} 的 GitHub API 调用,例如 https://api.github.com/repos/geojeff/kotti_software。您可以同时输入此 GitHub 信息和 PyPI URL,或者仅使用 GitHub 信息。
Bitbucket
输入 Bitbucket 拥有者和仓库,这将用于构建形式为:https://api.bitbucket.org/repostories/{拥有者}/{仓库} 的 Bitbucket API 调用。
正在进行中
kotti_software 被视为 alpha 软件包,目前还不适合用于生产环境。项目的当前状态既不完整,也不稳定。如果您真的想在您的项目(们)中使用它,请确保在 requirements 中固定确切的版本。不这样做,当未来版本发布时,很可能会破坏您的项目。
开发
欢迎为 kotti_software 做贡献。只需克隆其 GitHub 仓库 并以 pull request 的形式提交您的贡献。
请注意,所有开发都是在 develop 分支上进行的。 master 保留用于“生产就绪状态”。因此,请确保始终基于当前状态的 develop 分支进行开发工作。
这遵循了高度推荐的 Git 分支模式 模式,该模式由出色的 gitflow git 扩展实现。
测试
kotti_software 具有百分百的测试覆盖率。请确保您为新功能添加测试,并在提交拉取请求之前所有测试通过。运行测试套件就像在源目录中运行 py.test 一样简单(您可能需要运行 python setup.py dev 以在虚拟环境中安装所有测试需求)。
待办事项
添加国际化(i18n)支持
为项目添加 navpill-style 和 table-style 列表视图;在编辑菜单中使列表样式可选 [是否可以将此功能推迟到 Kotti 文件夹视图?]
整理并记录 setup.py 中可用的元数据项以及那些需要在 pypi 或 kotti_software 中手动输入的项。查看将 bugtrack_url、home_page 和 download_url 添加到 setup.py 后会发生什么。download_url 与 package_url 有何区别?setup.py 中的 url 是否映射到 home_page?[主页、下载 URL 和 bugtrack URL 可在 pypi 中编辑。如果它们不在 setup.py 中,那么如果手动在 pypi 中设置,它们是否会被新版本推送到 pypi 覆盖,或者它们会保持不变?]
检查是否需要从 kotti_media 复制所需的测试依赖项
添加使用标签按组分类的功能,或如果标签路由不可行,则添加“子集合”属性
目前,SoftwareCollection 视图对所有 SoftwareProject 项执行全局搜索。是否应将其更改为 context.children?[与标签和/或分类问题相关联。]
更改使用 all-jammed-up softwarecollection 的方式,将其更改为 software-collection 和 software_collection;同样适用于 softwareproject。或者,保持原样?
在默认列表视图中添加更好的项目分隔(目前唯一可用的列表视图样式;请参阅上面的待办事项项)
从 pypi 和 github 加载时的刷新是否过于昂贵?有哪些替代方案?夜间 cron 作业?更频繁的 cron 作业?定时刷新?每 5 分钟一次?每小时一次?由管理员手动触发?
变更记录
0.1.4
更新了说明文件,以包含修订后的使用说明。
0.1.3
将用户重命名为所有者,以适应 github 和 bitbucket。
在属性描述中,现在使用 PyPI、GitHub 和 Bitbucket 的拼写。
添加了 Bitbucket 作为 JSON 源。
移除了通用的 JSON 源选项,并使所有对 PyPI 的引用都明确。
0.1.2
添加了升序或降序排序的支持(默认仍为降序)。
添加了作为备用或唯一 JSON 源的 github 仓库 API 调用。
清理了排序代码。
0.1.1
添加了缺失的 TODO.txt。
更改了测试 URL 以访问 pypi/Kotti/json。
准备 MANIFEST.in。
根据 kotti_media 的模式更新了 README。
0.1
初始发布。
从 kotti_blog 的副本开始。
在开发过程中,参考了 kotti_media 以添加 URL 属性、设置视图类以及准备测试和使用 travis-ci.org。
项目详情
kotti_software-0.1.4.tar.gz 的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | a34b3ae41086b510c00c40f92e351209e48afebdf0d9fc3b247650457f143ea6 |
|
MD5 | 798b819cab3b2ff4997b93567b0a174e |
|
BLAKE2b-256 | d02948e6d033156fbde21890651dce715cd764027191ec2710d01756c42f79ca |