CONTRIBUTING.md

Contributing

Contributions are welcome, please take a look at the issues list.

Development environment

This project uses a standard layout. Here are some example steps to setup your development environment using pew:

1. Checkout project sources:

    git clone https://github.com/nicoulaj/rainbow.git
    cd rainbow
   

2. To run tests, rainbow uses tox:

    tox
   

   This will run all the tests, for all python versions. To run tests for one specific version:

    tox -e py27
   

   After you run tests, results (test, coverage and benchmark HTML reports) will be available in the build/tests directory.

Commands wishlist

This table contains an inventory of commands we could potentially support in rainbow, with their current status. If you want to request and/or plan to working on one, please send a pull request to update this table.

command / format	rainbow support	third party support	status
acpi	❌	cope
ant	❌	builtin color support, colorlogs	🆗
apm	❌	ccze
arp	❌	cope, cwrapper
arping	❌	cwrapper
auth.log	❌	cwrapper
blockdev	❌	cwrapper
cal	❌	cwrapper
cc	❌	cope	rainbow config needed
cksum	❌	cwrapper	rainbow config needed
clock	❌	cwrapper
configure	❌	cwrapper, grc	rainbow config needed
cpuinfo	❌	cwrapper	rainbow config needed
crontab	❌	cwrapper
cvs	❌	colorcvs, grc
date	❌	cwrapper
df	✔️	dfc, cope, cwrapper, grc	🆗
diff	✔️	colordiff, grc, cwrapper	🆗
dig	❌	cwrapper	rainbow config needed
distcc	❌	ccze
dmesg	❌	cwrapper
dpkg	❌	ccze
dprofpp	❌	cope
du	❌	cwrapper
env	✔️	cwrapper	🆗
esperanto	❌	grc
example	❌	colorlogs
exim	❌	ccze
fdisk	❌	cope
fetchmail	❌	ccze
figlet	❌	cwrapper
file	❌	cwrapper
find	❌	cwrapper	rainbow config needed
finger	❌	cwrapper
free	❌	cwrapper, cope	rainbow config needed
fstab	❌	cwrapper
ftpstats	❌	ccze
fuser	❌	cwrapper
gcc	❌	colorgcc, cope, cwrapper, grc
g++	❌	cwrapper, cope
git	❌	partial builtin color support, colorlogs
group	❌	cwrapper
groups	❌	cwrapper
hdparm	❌	cwrapper
hexdump	❌	cwrapper
host	✔️	cwrapper	🆗
hosts	❌	cwrapper
httpd	❌	ccze
icecast	❌	ccze
id	❌	cope, cwrapper	rainbow config needed
ifconfig	✔️	cwrapper, cope	🆗
inittab	❌	cwrapper
iptables	❌	cwrapper
irclog	❌	grc
java stack traces	✔️		🆗
last	❌	cwrapper
lastlog	❌	cwrapper
ldap	❌	grc
log	❌	grc
lsattr	❌	cwrapper
ls	❌	dircolors, cope
lsmod	❌	cwrapper
lsof	❌	cwrapper	rainbow config needed
lspci	❌	cope
lsusb	❌	cope
ltrace-color	❌	cwrapper
make	❌	colormake, cwrapper, cope	rainbow config needed
md5sum	✔️	cwrapper, cope	🆗
meminfo	❌	cwrapper
messages	❌	cwrapper
mount	❌	grc, cwrapper	rainbow config needed
mpc	❌	cope
mpg123	❌	cwrapper
mvn	✔️	colorslogs	🆗
netstat	❌	grc, cope, cwrapper	rainbow config needed
nfsstat	❌	cwrapper	rainbow config needed
nmap	❌	cwrapper, cope
nm	❌	cope
nocope	❌	cope
nslookup	❌	cwrapper
objdump	❌	cwrapper
oops	❌	ccze
passwd	❌	cwrapper
php	❌	ccze
ping	✔️	grc, cwrapper, cope	🆗
pmap	❌	cwrapper, cope
pmap_dump	❌	cwrapper
postfix	❌	ccze
praliases	❌	cwrapper
procmail	❌	ccze
proftpd	❌	grc, ccze
ps	❌	cwrapper, cope	rainbow config needed
pstree	❌	cwrapper	rainbow config needed
quota	❌	cwrapper
quotastats	❌	cwrapper
readelf	❌	cope
resolv	❌	cwrapper
route	❌	cwrapper, cope
routel	❌	cwrapper
screen	❌	cope
sdiff	❌	cwrapper
services	❌	cwrapper
sha1sum	❌	cope	rainbow config needed
sha224sum	❌	cope	rainbow config needed
sha256sum	❌	cope	rainbow config needed
sha384sum	❌	cope	rainbow config needed
sha512sum	❌	cope	rainbow config needed
shasum	❌	cope	rainbow config needed
showmount	❌	cwrapper
smbstatus	❌	cwrapper
socklist	❌	cope
squid	❌	ccze
stat	❌	cwrapper, cope
strace	❌	cope	rainbow config needed
sulog	❌	ccze
super	❌	ccze
svn	❌	colorsvn
sysctl	❌	cwrapper
syslog	❌	cwrapper, ccze
tar	❌	cwrapper
tcpdump	❌	cwrapper, cope
tomcat	✔️		🆗
tracepath	❌	cwrapper, cope
traceroute	✔️	cope, grc, cwrapper	🆗
ulogd	❌	ccze
umount	❌	cwrapper
uname	❌	cwrapper
uptime	❌	cwrapper
users	❌	cwrapper
vmstat	❌	cwrapper
vsftpd	❌	ccze
wc	❌	cwrapper
w	❌	cwrapper, cope
wdiff	❌	grc
wget	❌	cope
whereis	❌	cwrapper
who	❌	cwrapper, cope
xferlog	❌	cwrapper, ccze
xrandr	❌	cope