1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
#!/usr/bin/env python3
"""
Copyright 2020 Kat Holt
Copyright 2020 Ryan Wick (rrwick@gmail.com)
https://github.com/katholt/Kleborate/
This file is part of Kleborate. Kleborate is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version. Kleborate is distributed in
the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details. You should have received a copy of the GNU General Public License along with Kleborate. If
not, see <http://www.gnu.org/licenses/>.
"""
import os
import sys
import subprocess
import distutils.spawn
from setuptools import setup
from setuptools.command.install import install
def readme():
with open('README.md') as f:
return f.read()
# Get the program version from another file.
__version__ = '0.0.0'
exec(open('kleborate/version.py').read())
def check_dir_write_permission(directory):
if os.path.isdir(directory) and not os.access(directory, os.W_OK):
sys.exit('Error: no write permission for ' + directory + ' ' +
'Perhaps you need to use sudo?')
def build_blast_db(data_dir, fasta_filename, seq_type):
fasta_path = os.path.join(data_dir, fasta_filename)
makeblastdb_cmd = ['makeblastdb', '-dbtype', seq_type, '-in', fasta_path]
print(' ' + ' '.join(makeblastdb_cmd))
with open(os.devnull, 'w') as devnull:
subprocess.check_call(makeblastdb_cmd, stdout=devnull)
class KleborateInstall(install):
"""
This is a subclass of install where I've added a couple things to the installation process:
* building BLAST databases with makeblastdb
* printing example commands
"""
def run(self):
check_dir_write_permission(self.install_lib)
check_dir_write_permission(self.install_scripts)
# Call the base class run to do the bulk of the installation.
install.run(self)
# Build the BLAST databases now, as the user may not have write permissions to the
# installation directory when running Kleborate.
print('')
data_dir = os.path.join(self.install_lib, 'kleborate', 'data')
if not distutils.spawn.find_executable('makeblastdb'):
print('Warning: could not find makeblastdb, so BLAST databases were not built.')
print('They can be built when you run Kleborate, but this will require write '
'permissions to the data directory:')
print(data_dir)
else:
check_dir_write_permission(data_dir)
print('Building BLAST databases with makeblastdb:')
try:
for fasta in ['CARD_v3.0.8.fasta', 'clb_alleles.fasta', 'rmpA2.fasta',
'iro_alleles.fasta', 'iuc_alleles.fasta', 'rmp_alleles.fasta',
'Klebsiella_pneumoniae.fasta', 'wzi.fasta', 'ybt_alleles.fasta',
'MgrB_and_PmrB.fasta', 'OmpK.fasta', 'QRDR_120.fasta']:
build_blast_db(data_dir, fasta, 'nucl')
except subprocess.CalledProcessError:
print('\n')
print('Warning: makeblastdb failed, so BLAST databases were not built.')
print('They can be built when you run Kleborate, but this will require write '
'permissions to the data directory:')
print(data_dir)
ascii_art = " _ __ _ ______ ____ ____ _____ _______ ______ \n" \
"| | / /| | | ____| _ \ / __ \| __ \ /\|__ __| ____|\n" \
"| |/ / | | | |__ | |_) | | | | |__) | / \ | | | |__ \n" \
"| < | | | __| | _ <| | | | _ / / /\ \ | | | __| \n" \
"| |\ \ | |___| |____| |_) | |__| | | \ \/ ____ \| | | |____ \n" \
"|_| \_\|_____|______|____/ \____/|_| \_\/ \_\_| |______|\n"
print('\n')
print('\033[1m' + ascii_art + '\033[0m') # bold formatting
print('Kleborate is installed and ready to use!')
print('')
print('Example commands:')
print(' kleborate --help')
print(' kleborate -o results.txt -a *.fasta')
print(' kleborate --resistance -o results.txt -a *.fasta')
print(' kleborate --all -o results.txt -a *.fasta')
print('')
setup(name='Kleborate',
version=__version__,
description='Kleborate',
long_description=readme(),
classifiers=['Development Status :: 4 - Beta',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 3',
'Topic :: Scientific/Engineering :: Bio-Informatics',
'Topic :: Scientific/Engineering :: Medical Science Apps.',
'Intended Audience :: Science/Research'],
keywords='microbial genomics sequence typing',
url='https://github.com/katholt/Kleborate',
author='Kathryn Holt',
author_email='',
packages=['kleborate', 'kaptive'],
install_requires=['biopython'],
entry_points={'console_scripts': ['kleborate = kleborate.__main__:main']},
include_package_data=True,
zip_safe=False,
cmdclass={'install': KleborateInstall})
|
