Metadata-Version: 1.1
Name: monoseq
Version: 1.2.0
Summary: A Python library for pretty-printing DNA and protein sequences using a monospace font
Home-page: https://github.com/martijnvermaat/monoseq
Author: Martijn Vermaat
Author-email: martijn@vermaat.name
License: MIT License
Description: ``monoseq``
        ===========
        
        ``monoseq`` is a Python library for pretty-printing sequence strings using a
        monospace font. It also provides a simple command line interface.
        
        Sequences are pretty-printed in the for DNA and proteins traditional way
        using blocks of letters where each line is prefixed with the sequence
        position. User-specified regions are highlighted using different formatting
        styles. The output format can be HTML or plaintext with optional styling
        using ANSI escape codes for use in a terminal.
        
        .. code-block:: pycon
        
            >>> import monoseq
            >>> sequence = 'MIMANQPLWLDSEVEMNHYQQSHIKSKSPYFPEDKHICWIKIFKAFGT' * 4
            >>> print monoseq.pprint_sequence(sequence, mode='plaintext')
              1  MIMANQPLWL DSEVEMNHYQ QSHIKSKSPY FPEDKHICWI KIFKAFGTMI MANQPLWLDS
             61  EVEMNHYQQS HIKSKSPYFP EDKHICWIKI FKAFGTMIMA NQPLWLDSEV EMNHYQQSHI
            121  KSKSPYFPED KHICWIKIFK AFGTMIMANQ PLWLDSEVEM NHYQQSHIKS KSPYFPEDKH
            181  ICWIKIFKAF GT
        
        This screenshot shows the use of ANSI escape codes:
        
        .. image:: doc/example-ansi.png
           :alt: Example of formatting with ANSI escape codes
        
        And `here you can find an example <doc/example-html.html>`_ of using
        ``monoseq`` output in HTML.
        
        To install the latest release via PyPI using pip::
        
            pip install monoseq
        
        
        Documentation
        -------------
        
        The `latest documentation <https://monoseq.readthedocs.org/>`_ with user
        guide and API reference is hosted at Read The Docs.
        
        You can also compile the documentation directly from the source code by
        running ``make html`` from the ``doc/`` subdirectory. This requires
        `Sphinx`_ to be installed.
        
        
        Copyright
        ---------
        
        ``monoseq`` is licensed under the MIT License, see the LICENSE.rst file
        for details. See the AUTHORS.rst file for a list of authors.
        
        
        .. _Sphinx: http://sphinx-doc.org/
        
Keywords: bioinformatics
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
