Skip to content

docs: Pynteny is on PyPI — lead with pip install pynteny #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Robaina merged 1 commit into from
Jun 19, 2026
Merged

docs: Pynteny is on PyPI — lead with pip install pynteny #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
![license](https://img.shields.io/github/license/Robaina/Pynteny)
![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4)

[![PyPI version](https://img.shields.io/pypi/v/pynteny?logo=pypi&style=flat-square)](https://pypi.org/project/pynteny/)
[![GitHub release](https://img.shields.io/github/release/Robaina/Pynteny.svg)](https://GitHub.com/Robaina/Pynteny/releases/)

![python](https://img.shields.io/badge/Python-3.9%20|%203.12-blue)
Expand All @@ -36,16 +37,16 @@ binaries). All dependencies, including the HMMER and Prodigal engines, are
provided by the pip packages [pyhmmer](https://github.com/althonos/pyhmmer) and
[pyrodigal](https://github.com/althonos/pyrodigal).

Install the latest development version directly from GitHub:
Install with pip:

```bash
pip install git+https://github.com/Robaina/Pynteny.git
pip install pynteny
```

Once released on PyPI, Pynteny will also be installable with:
Or install the latest development version directly from GitHub:

```bash
pip install pynteny
pip install git+https://github.com/Robaina/Pynteny.git
```

Check that the installation worked fine:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/example_api_colab.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"try:\n",
" import google.colab\n",
" # Pynteny is a pure-pip package (no conda / external binaries required).\n",
" !pip install -q git+https://github.com/Robaina/Pynteny.git\n",
" !pip install -q pynteny\n",
" # Grab the bundled test data used throughout this example.\n",
" !git clone -q https://github.com/Robaina/Pynteny.git\n",
" !cp -r Pynteny/tests/ . && rm -rf Pynteny\n",
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ binaries). The HMMER and Prodigal engines are provided by the pip packages
[pyhmmer](https://github.com/althonos/pyhmmer) and
[pyrodigal](https://github.com/althonos/pyrodigal).

Install the latest development version directly from GitHub:
Install with pip:

```bash
pip install git+https://github.com/Robaina/Pynteny.git
pip install pynteny
```

Once released on PyPI, Pynteny will also be installable with:
Or install the latest development version directly from GitHub:

```bash
pip install pynteny
pip install git+https://github.com/Robaina/Pynteny.git
```

Check that installation worked fine:
Expand Down
Loading