cheat-fork-echo/cheat

102 lines
3.1 KiB
Text
Raw Normal View History

2013-07-31 04:48:07 +02:00
#!/usr/bin/env python
import os
2013-07-31 04:48:07 +02:00
import sys
2013-08-21 11:33:09 +02:00
try:
from pygments import highlight
from pygments.util import ClassNotFound
from pygments.lexers import get_lexer_for_filename, TextLexer
from pygments.formatters import TerminalFormatter
USE_PYGMENTS = True
except ImportError:
USE_PYGMENTS = False
2013-08-21 09:00:24 +02:00
2013-08-21 08:46:10 +02:00
def cheat_directories():
2013-08-21 08:46:10 +02:00
"Assembles a list of directories containing cheatsheets."
default_directories = [os.path.expanduser('~/.cheat')]
try:
import cheatsheets
default_directories.append(cheatsheets.cheat_dir)
except ImportError:
pass
2013-08-21 08:46:10 +02:00
default = [default_dir for default_dir in default_directories
if os.path.isdir(default_dir)]
if 'CHEATPATH' in os.environ and os.environ['CHEATPATH']:
2013-08-21 08:46:10 +02:00
return [path for path in os.environ['CHEATPATH'].split(os.pathsep)
if os.path.isdir(path)] + default
else:
return default
2013-08-21 08:46:10 +02:00
def cheat_files(cheat_directories):
2013-08-21 08:46:10 +02:00
"Assembles a dictionary of cheatsheets found in the above directories."
cheats = {}
for cheat_dir in reversed(cheat_directories):
2013-08-21 08:46:10 +02:00
cheats.update(dict([(cheat, cheat_dir)
for cheat in os.listdir(cheat_dir)
if not cheat.startswith('.')]))
return cheats
2013-08-10 05:46:34 +02:00
2013-08-21 08:46:10 +02:00
def main():
# assemble a keyphrase out of all params passed to the script
2013-08-21 08:46:10 +02:00
keyphrase = ' '.join(sys.argv[1:])
cheat_dirs = cheat_directories()
# verify that we have at least one cheat directory
if not cheat_dirs:
2013-08-21 08:46:10 +02:00
print >> sys.stderr, ('The ~/.cheat dir does not exist or the '
'CHEATPATH var is not set.')
exit()
# list the files in the ~/.cheat directory
cheatsheets = cheat_files(cheat_dirs)
# print help if requested
if keyphrase.lower() in ['', 'cheat', 'help', '-h', '-help', '--help']:
print "Usage: cheat [keyphrase]\n"
print "Available keyphrases:"
2013-08-21 08:46:10 +02:00
max_command = max([len(x) for x in cheatsheets.keys()]) + 3
print '\n'.join(sorted(['%s [%s]' % (key.ljust(max_command), value)
for key, value in cheatsheets.items()]))
exit()
# print the cheatsheet if it exists
if keyphrase in cheatsheets:
2013-08-21 08:46:10 +02:00
filename = os.path.join(cheatsheets[keyphrase], keyphrase)
2013-08-21 11:33:09 +02:00
if USE_PYGMENTS:
pretty_print(filename)
else:
with open(filename) as istream:
for l in istream:
sys.stdout.write(l)
# if it does not, say so
else:
print 'No cheatsheet found for %s.' % keyphrase
2013-08-21 08:46:10 +02:00
2013-08-21 09:00:24 +02:00
def pretty_print(filename):
try:
if os.path.splitext(filename)[1]:
lexer = get_lexer_for_filename(filename)
else:
# shell is a sensible default when there is no extension
lexer = get_lexer_for_filename(filename + '.sh')
except ClassNotFound:
lexer = TextLexer()
with open(filename) as istream:
code = istream.read()
fmt = TerminalFormatter()
highlight(code, lexer, fmt, sys.stdout)
if __name__ == '__main__':
main()