Metadata-Version: 2.1
Name: c3pred
Version: 0.5
Summary: Prediction of cargo transport potential of short peptides.
Home-page: https://github.com/steffenlem/c3pred
Author: iGEM Tuebingen
Author-email: info@igem-tuebingen.de
License: MIT license
Keywords: c3pred
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Requires-Dist: click
Requires-Dist: xgboost
Requires-Dist: numpy
Requires-Dist: urllib3
Requires-Dist: xmltodict
Requires-Dist: biopython

======
C3Pred
======


.. image:: https://img.shields.io/pypi/v/c3pred.svg
        :target: https://pypi.python.org/pypi/c3pred

.. image:: https://img.shields.io/travis/steffenlem/c3pred.svg
        :target: https://travis-ci.org/steffenlem/c3pred

.. image:: https://readthedocs.org/projects/c3pred/badge/?version=latest
        :target: https://c3pred.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


.. image:: https://pyup.io/repos/github/steffenlem/c3pred/shield.svg
     :target: https://pyup.io/repos/github/steffenlem/c3pred/
     :alt: Updates


Software project of the iGEM Team Tübingen 2019
Prediction of cargo transport potential of short peptides.


* Free software: MIT license
* Documentation: https://c3pred.readthedocs.io.




Installation
------------
.. code-block:: bash

	$ git clone https://github.com/steffenlem/c3pred.git
	$ python setup.py install
	$ c3pred



Usage
-----
The CLI - Command Line Interface

.. code-block:: bash

	Usage: c3pred [OPTIONS]

	  Console script for c3pred.

	Options:
	  -s, --sequence TEXT  If the input is a FASTA protein string, please use this flag
	  -u, --uniprot TEXT   If the input is a UniProtKB accession number, please use this flag
	  -g, --igem TEXT      If the input is a iGEM Registry ID, please use this flag
	  --help               Show this message and exit.


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

iGEMtuebingen (2019-10-16)
--------------------------

* First release on PyPI.


