Skip to content

Commit

Permalink
getting click to work
Browse files Browse the repository at this point in the history
  • Loading branch information
proost committed May 8, 2017
1 parent 07efab8 commit 77a403f
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ Tool to detect potential transposable elements in a fasta file. Some classes of
To solve this issue these TEs should be detected and removed in all genomes prior to doing a comparative analysis (e.g. counting genes, constructing gene families, ...). De-TE-ctor is a small pipeline to quickly check for putative TEs included in the set of protein coding genes of a genome and report them so they can be removed.


## Usage

### Installation

Clone the package from the git repository

git clone https://github.molgen.mpg.de/proost/De-TE-ctor detector
cd detector

Create a virtual environment

virtualenv --python=python3 venv
source env/bin/activate
pip install -r requirements.txt

Install the detector module

pip install --editable .

### Commands

TODO

* Collect sequences for known protein coding transposable elements.
Expand Down
30 changes: 30 additions & 0 deletions detector.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import click


@click.group()
def cli():
"""
Detector can be used to detect transposable elements in a fasta file.
usage: detector <command>
potential commands:
build : build the database
blast : blasts a fasta file agains a database
analyze : checks the blast output if TEs are present
"""
pass


@cli.command()
@click.argument('path', type=click.path())
def build(path):
"""
Builds the blast database.
usage: detector build PATH (the directory with .fasta files to build the database)
"""
click.echo("Building the database ... ")
click.echo("Input path: %s" % path)

1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
click==6.7
14 changes: 14 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
from setuptools import setup

setup(
name='DeTEctor',
version='0.1',
py_modules=['detector'],
install_requires=[
'Click',
],
entry_points='''
[console_scripts]
detector=detector:cli
'''
)

0 comments on commit 77a403f

Please sign in to comment.