XAEA12 Python项目
x-ae-a-12的Python项目详细描述
X-AE-A-12型
命令行应用程序,用于在控制台上显示来自wikipedia的随机事实。 在PyPI上作为python包提供:
pip install x-ae-a-12
文档可在:X-AE-A-12 docs
目录
- Built With
- Features
- Code Example
- Prerequisites
- Installation
- Tests
- Deployment
- Contributions
- Bug / Feature Request
- Authors
- License
用
- ^{a20-使用的编程语言。在
- Poetry-使用的依赖关系管理器。在
- Nox-使用的自动化工具。在
- Pytest-使用的测试框架。在
- Flake8-使用的皮棉工具。在
- Sphinx-使用的文档生成器。在
- GitHub Actions-使用了CI-CD工具。在
特点
- 显示维基百科中的随机事实。在
- 选择要使用的Wikipedia语言版本。在
代码示例
^{pr2}$先决条件
安装软件需要什么东西以及如何安装
- python 3.8
Linux系统:
sudo apt-get install python3.8
窗口:
从python.org下载
Mac操作系统:
brew install python3
- pip
Linux和Mac OS:
pip install -U pip
窗口:
python -m pip install -U pip
- 诗歌
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
- nox
pip install --user --upgrade nox
安装
克隆此存储库:
git clone https://github.com/SpencerOfwiti/X-AE-A-12
要设置虚拟环境并安装依赖项,请执行以下操作:
poetry install
要运行应用程序(默认选择英语版本):
poetry run x-ae-a-12
斯瓦希里语版:
poetry run x-ae-a-12 -l sw
测试
此系统使用pytest运行自动测试。在
要运行自动测试:
nox -s tests
部署
要在PyPI(Python包索引)上部署应用程序,请执行以下操作:
poetry build
poetry publish
捐款
要做出贡献,请遵循以下步骤:
- 分叉这个存储库。在
- 创建一个分支:
git checkout -b <branch_name>
。在 - 进行更改并提交:
git commit -m '<commit_message>'
- 推到原始分支:
git push origin <project_name>/<location>
- 创建拉取请求。在
或者,请参阅creating a pull request上的GitHub文档。在
错误/功能请求
如果发现错误(网站无法处理查询和/或给出不希望的结果),请通过包含搜索查询和预期结果来打开问题here。在
如果您想请求一个新函数,可以打开一个问题here。请包括示例查询及其相应的结果。在
作者
- Spencer Ofwiti-初始工作
另请参阅参与本项目的contributors人员名单。在
许可证
这个项目是在麻省理工学院许可下授权的-有关详细信息,请参阅LICENSE.md文件
- 项目
标签: