Skip to content

Commit

Permalink
Correct long_description for pypi publish
Browse files Browse the repository at this point in the history
  • Loading branch information
bvalot committed Apr 10, 2024
1 parent 18b20a3 commit 1f4aa75
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Conda installation

You can easy install panisa program and requirements using conda:

.. raw:: html
.. code-block:: bash
<pre>conda install -c bioconda panisa</pre>
conda install -c bioconda panisa
Requirements
~~~~~~~~~~~~
Expand All @@ -41,9 +41,9 @@ You need to install `the emboss package <http://emboss.sourceforge.net>`_

In debian, type:

.. raw:: html
.. code-block:: bash
<pre>sudo apt-get install python-pysam python-requests emboss</pre>
sudo apt-get install python-pysam python-requests emboss
Installation
~~~~~~~~~~~~
Expand All @@ -52,23 +52,23 @@ Download the current tarball and unzip it.

Verify the installation using the test file

.. raw:: html
.. code-block:: bash
<pre>python panISa.py test/test.bam</pre>
python panISa.py test/test.bam
Alternatively, you can install from `PyPI repository <https://pypi.python.org/pypi>`_

.. raw:: html
.. code-block:: bash
<pre>pip install panisa</pre>
pip install panisa
Command and Options
-------------------

.. raw:: html
.. code-block:: bash
<pre>python panISa.py [options] bam</pre>
python panISa.py [options] bam
Options
~~~~~~~
Expand Down Expand Up @@ -112,9 +112,9 @@ Validation

PanISa results can be search for homology against ISFinder to find IS familly using the script ISFinder_search.py

.. raw:: html
.. code-block:: bash
<pre>python ISFinder_search.py [options] panISa results</pre>
python ISFinder_search.py [options] panISa results
Recommandation
--------------
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@
#
# This field corresponds to the "Description" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-optional
# long_description=long_description, # Optional
long_description=long_description, # Optional
long_description_content_type='text/x-rst',

# This should be a valid link to your project's main homepage.
#
Expand Down

0 comments on commit 1f4aa75

Please sign in to comment.