跳转到主要内容

cheminfo ELN的Python SDK

项目描述

cheminfopy

Tests Cookiecutter template from @cthoyt PyPI PyPI - Python Version PyPI - License Documentation Status Code style: black

cheminfo ELN的Python SDK

💪 开始使用

TODO 在非常小的空间内展示你的包可以做的最有用的事情。尽量简短!你将有完整的文档供后续参考。

命令行界面

cheminfopy命令行工具会自动安装。可以通过shell使用--help标志来显示所有子命令。

$ cheminfopy --help

TODO 展示CLI最有用的事情!CLI将由sphinx自动生成文档。

🚀 安装

最新的代码和数据可以通过以下方式从GitHub直接安装

$ pip install git+https://github.com/cheminfo-py/cheminfopy.git

要开发模式安装,使用以下命令

$ git clone git+https://github.com/cheminfo-py/cheminfopy.git
$ cd cheminfopy
$ pip install -e .

👐 贡献

贡献,无论是提交问题、创建pull request还是fork,都是受欢迎的。有关参与的更多信息,请参阅CONTRIBUTING.rst

👋 归档

⚖️ 许可证

本包中的代码采用MIT许可证。

🍪 Cookiecutter

本包是由@audreyfeldroycookiecutter包和@cthoytcookiecutter-snekpack模板创建的。

🛠️ 开发者

查看开发者说明

README的最后一节是关于如果你想要通过贡献代码来参与进来。

❓ 测试

克隆存储库并使用pip install tox安装tox后,可以使用以下命令在tests/文件夹中可重复运行单元测试

$ tox

此外,这些测试在每个提交时都会通过GitHub Action自动重新运行。

📦 制作发布版本

在开发模式下安装包并使用pip install tox安装tox后,在tox.inifinish环境中包含了制作新版本的命令。在shell中运行以下命令

$ tox -e finish

此脚本执行以下操作

  1. 使用BumpVersion将setup.cfgsrc/cheminfopy/version.py中的版本号切换为不带-dev后缀
  2. 将代码打包成tar存档和wheel
  3. 使用twine上传到PyPI。确保配置了.pypirc文件,以避免在此步骤中需要手动输入
  4. 推送到GitHub。您需要创建一个与版本升级提交相关的发布版本。
  5. 将版本升级到下一个补丁版本。如果您进行了重大更改并希望通过小版本号升级版本,可以在之后使用tox -e bumpversion minor

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

cheminfopy-0.9.0.tar.gz (232.0 kB 查看哈希值)

上传时间

构建分布

cheminfopy-0.9.0-py3-none-any.whl (17.6 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面