跳转到主要内容

使用Ideogram.js生成核型图。

项目描述

pydeogram

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

使用Ideogram.js生成核型图。

💪 入门

pydeogram 帮助您使用 Ideogram.js 为您的基因列表制作核型图。

import pydeogram

symbols = ["ARFGEF1", "ARFGEF2", "ARFGEF3"]
pydeogram.to_html_path(symbols, path="~/Desktop/argef_ideogram.html")

这也适用于Jupyter笔记本。请注意,您需要连续运行 prepare_jupyterto_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

本软件包使用@audreyfeldroycookiecutter包,以及@cthoytcookiecutter-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.inifinish环境中。在shell中运行以下命令

$ tox -e finish

此脚本执行以下操作

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

项目详情


下载文件

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

源代码发行版

pydeogram-0.0.2.tar.gz (272.6 kB 查看散列)

上传时间 源代码

构建发行版

pydeogram-0.0.2-py3-none-any.whl (11.4 kB 查看散列)

上传时间 Python 3

支持者