bumped version to 1.2.1

andim · Oct 4, 2023 · 9dce2f3 · 9dce2f3
1 parent ab9adaf
commit 9dce2f3
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/pyrepseq/version.py b/pyrepseq/version.py
@@ -2,8 +2,8 @@
 
 # Format expected by setup.py and doc/source/conf.py: string of form "X.Y.Z"
 _version_major = 1
-_version_minor = 1
-_version_micro = ''  # use '' for first of series, number for 1 and above
+_version_minor = 2
+_version_micro = '1'  # use '' for first of series, number for 1 and above
 #_version_extra = 'dev'
 _version_extra = ''  # Uncomment this for full releases
 
@@ -30,6 +30,32 @@
 # Long description will go up on the pypi page
 long_description = """
 Pyrepseq = scipy & seaborn for studying adaptive immunity: modular implementations of algorithms for fast analyses, and bespoke plotting functions for compelling visualizations.
+
+
+## Documentation and examples
+
+You can find API documentation on [readthedocs](https://pyrepseq.readthedocs.io/en/latest/?badge=latest)
+
+There are jupyter notebooks illustrating some of the functionality in the 'examples' folder.
+
+You can also find usage examples by looking at the code underlying our recent paper [Mayer Callan PNAS 2023](https://github.com/andim/paper_coincidences).
+
+## Installation
+
+The quickest way to install Pyrepseq is via pip:
+
+`pip install pyrepseq`
+
+
+Pyrepseq can also be installed from its [Github](https://github.com/andim/pyrepseq) source, by running `python setup.py install` in the main directory.
+
+## Support and contributing
+
+For bug reports and enhancement requests use the [Github issue tool](http://github.com/andim/pyrepseq/issues/new), or (even better!) open a [pull request](http://github.com/andim/pyrepseq/pulls) with relevant changes. If you have any questions don't hesitate to contact us by email (andimscience@gmail.com) or Twitter ([@andimscience](http://twitter.com/andimscience)).
+
+You can run the testsuite by running `pytest` in the top-level directory.
+
+You are cordially invited to [contribute](https://github.com/andim/pyrepseq/blob/master/CONTRIBUTING.md) to the further development of pyrepseq!
 """
 
 NAME = "pyrepseq"

diff --git a/setup.py b/setup.py
@@ -13,6 +13,7 @@
             maintainer_email=MAINTAINER_EMAIL,
             description=DESCRIPTION,
             long_description=LONG_DESCRIPTION,
+            long_description_content_type='text/markdown',
             url=URL,
             download_url=DOWNLOAD_URL,
             license=LICENSE,