使用Ideogram.js生成核型图。
项目描述
pydeogram
使用Ideogram.js生成核型图。
💪 入门
pydeogram
帮助您使用 Ideogram.js 为您的基因列表制作核型图。
import pydeogram
symbols = ["ARFGEF1", "ARFGEF2", "ARFGEF3"]
pydeogram.to_html_path(symbols, path="~/Desktop/argef_ideogram.html")
这也适用于Jupyter笔记本。请注意,您需要连续运行 prepare_jupyter
和 to_jupyter
函数。我正在寻找一个修复方案,以便它可以在一个函数中,但JavaScript很难。
pydeogram
有一个CLI可以完成同样的事情
$ pydeogram write ARFGEF1 ARFGEF2 ARFGEF3 -o ~/Desktop/argef_ideogram.html
🚀 安装
可以从 PyPI 安装最新版本
$ pip install pydeogram
可以从GitHub直接安装最新代码和数据
$ pip install git+https://github.com/cthoyt/pydeogram.git
👐 贡献
贡献,无论是提交问题、创建拉取请求还是分支,都受到欢迎。有关参与的更多信息,请参阅 CONTRIBUTING.md。
👋 属性
⚖️ 许可证
本包中的代码根据MIT许可证许可。
🍪 Cookiecutter
本软件包使用@audreyfeldroy的cookiecutter包,以及@cthoyt的cookiecutter-snekpack模板创建。
🛠️ 开发者指南
请参阅开发者说明
README的最后一节是关于如果您想通过代码贡献来参与其中。
开发安装
要使用开发模式安装,请使用以下命令
$ git clone git+https://github.com/cthoyt/pydeogram.git
$ cd pydeogram
$ pip install -e .
🥼 测试
克隆存储库并使用pip install tox
安装tox
后,可以使用以下命令可重复运行tests/
文件夹中的单元测试
$ tox
此外,这些测试会在每次提交时自动通过GitHub Action重新运行。
📖 构建文档
可以使用以下命令在本地构建文档
$ git clone git+https://github.com/cthoyt/pydeogram.git
$ cd pydeogram
$ tox -e docs
$ open docs/build/html/index.html
文档会自动安装包以及setup.cfg
中指定的docs
额外内容。可以在此处添加如texext
之类的docs/source/conf.py
中的extensions
列表中。
📦 发布版本
在开发模式下安装包并使用pip install tox
安装tox
后,创建新版本的命令包含在tox.ini
的finish
环境中。在shell中运行以下命令
$ tox -e finish
此脚本执行以下操作
- 使用Bump2Version将
setup.cfg
、src/pydeogram/version.py
和docs/source/conf.py
中的版本号切换为不带-dev
后缀 - 使用
build
在tar存档和wheel中打包代码 - 使用
twine
上传到PyPI。请确保已配置.pypirc
文件,以避免在此步骤中手动输入 - 推送到GitHub。您需要创建一个与版本升级提交相对应的发布版本
- 将版本升级到下一个补丁。如果您进行了重大更改并希望通过次要版本升级版本,则可以在之后使用
tox -e bumpversion minor
项目详情
下载文件
下载您平台上的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码发行版
构建发行版
pydeogram-0.0.2.tar.gz的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 2c51a3668964ca1312f46cf9402056cb2bf78da9c238f8cfb4d48408a8b0ad52 |
|
MD5 | 0331a8753fcb50e2a7893940e69aed0c |
|
BLAKE2b-256 | eb03e4b1ac99d4013117e29f9d9c4abd428c052b4b5d2e8961710de7183f6df9 |