Skip to content

Commit

Permalink
Adding to PyPI
Browse files Browse the repository at this point in the history
Closes #5
Can update to v1.0 when ready
  • Loading branch information
johnlees committed Jun 4, 2018
1 parent b0a7189 commit 4a4e7f6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# PopPUNK (POPulation Partitioning Using Nucleotide Kmers)

[![Build Status](https://travis-ci.org/johnlees/PopPUNK.svg?branch=master)](https://travis-ci.org/johnlees/PopPUNK/)
[![Documentation Status](https://poppunk.readthedocs.io/en/latest/?badge=latest)]((https://poppunk.readthedocs.io/)
[![PyPI version](https://badge.fury.io/py/poppunk.svg)](https://badge.fury.io/py/poppunk)

Step 1) Use k-mers to calculate core and accessory distances

Step 2) Use core and accessory distance distribution to define strains

Step 3) Pick references from strains, which can be used to assign new
query sequences

See the [documentation](http://poppunk.readthedocs.io/en/master/).
See the [documentation](http://poppunk.readthedocs.io/en/latest/).

## Installation
The easiest way is through pip, which we would also recommend being
Expand Down Expand Up @@ -88,7 +92,7 @@ poppunk --assign-query \

If running without having installed through PyPI, run `python poppunk-runner.py` instead of `poppunk`.

See the [documentation](http://poppunk.readthedocs.io/en/master/) for
See the [documentation](http://poppunk.readthedocs.io/en/latest/) for
full details.


2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def find_version(*file_paths):
packages=['PopPUNK'],
entry_points={
"console_scripts": [
'poppunk = PopPUNK.__main__:main'
'poppunk = PopPUNK.__main__:main',
'prune_poppunk = PopPUNK.prune_db:main'
]
},
Expand Down

0 comments on commit 4a4e7f6

Please sign in to comment.