westurner / dotfiles Goto Github PK

Bash, Python, IPython scripts, and userspace configuration https://westurner.org/dotfiles/

Home Page: https://westurner.org/dotfiles/

License: BSD 3-Clause "New" or "Revised" License

Shell 40.86% Python 52.34% Makefile 0.80% GLSL 0.01% CSS 0.01% JavaScript 0.01% Ruby 0.03% Vim Script 1.07% Roff 0.12% HTML 4.76%

shell python ipython gnome i3wm bashrc virtualenv virtualenvwrapper conda makefile

dotfiles's Introduction

Dotfiles

Source: https://github.com/westurner/dotfiles
Download: https://github.com/westurner/dotfiles/releases
Build: https://travis-ci.org/westurner/dotfiles
Docs: https://westurner.org/dotfiles/
Docs: https://westurner.github.io/dotfiles/
Docs: https://wrdfiles.readthedocs.org/en/latest/

Goals

Streamline frequent workflows
Configure Bash, ZSH, and Vim
Configure Python, pip, virtualenv, virtualenvwrapper
Configure IPython
Configure Gnome
Configure i3wm
Support Debian Linux, Ubuntu Linux, OSX
Document commands and keyboard shortcuts
Create a productive working environment

Installation

Requirements

Project requirements are installed by bootstrap_dotfiles.sh and/or, optionally, also a Makefile.

Bash, Git, Python, pip

Install the dotfiles

Source: https://github.com/westurner/dotfiles
Documentation: https://westurner.org/dotfiles/

The bootstrap_dotfiles.sh shell script:

clones the dotfiles and dotvim repositories
creates symlinks from HOME to __DOTFILES,
installs the dotfiles Python package,
installs additional requirements with pip

wget bootstrap_dotfiles.sh
bash ./scripts/bootstrap_dotfiles.sh -I -R

Create a virtualenv with virtualenvwrapper named "dotfiles":

# Install virtualenvwrapper
pip install virtualenvwrapper   # apt-get install python-virtualenvwrapper
source $(which 'virtualenvwrapper.sh')    # 07-bashrc.virtualenvwrapper.sh

export WORKON_HOME="~/-wrk/-ve27"                    # __WRK/-ve python2.7      
mkdir -p $WORKON_HOME

# Create a virtualenvwrapper virtualenv
mkvirtualenv dotfiles  # workon dotfiles
mkdir $VIRTUAL_ENV/src
cd $VIRTUAL_ENV/src

# Clone the dotfiles git repository
branch="master"     # stable
# branch="develop"  # development
git clone ssh://[email protected]/westurner/dotfiles -b ${branch}
cd dotfiles

# Install dotfiles pkg, symlinks, and extra pip requirements
scripts/bootstrap_dotfiles.sh -I -R         # -I calls -S

With Python builds that haven't set a prefix which is writeable by the current user, you can also install into ~/.local with pip --user:

# (Optional) Also install pkg and reqs into ~/.local/bin (pip --user)
# scripts/bootstrap_dotfiles.sh -I -R -u

Note

See Quickstart, which uses venv-style paths.

Source the dotfiles

Bash (and ZSH) configuation sets are sequentially numbered 00-99.

00-bashrc.before.sh sources a documented, numerically sequential sequence of bash scripts.
ZSH loads much of the standard Bash configuration and oh-my-zsh.

00-zshrc.before.sh

bootstrap_dotfiles.sh -S installs dotfiles ${__DOTFILES} symlinks.

ln -s ~/-dotfiles/etc/.bashrc ~/.bashrc
ln -s ~/-dotfiles/etc/.zshrc ~/.zshrc

# Source the dotfiles
source ~/.bashrc                                         # source ~/.zshrc

# source ${__DOTFILES}/etc/.bashrc
## source ${__DOTFILES}/etc/bash/00-bashrc.before.sh     # dotfiles_reload
### dotfiles configuration sequence                # (\d\d)-bashrc.(.*).sh
#### source ${__DOTFILES}/etc/bash/99-bashrc.after.sh
##### source ${__PROJECTSRC}                     # ${__WRK}/.projectsrc.sh

# print venv configuration
dotfiles_status
ds

Last login: Tue Dec  2 15:01:56 on ttys000
#
# dotfiles_reload()
#ntid  _TERM_ID="#SElGeTf5VcA"  #_USRLOG="/Users/W/-usrlog.log"
# dotfiles_status()
HOSTNAME='nb-mb1'
USER='W'
__WRK='/Users/W/-wrk'
PROJECT_HOME='/Users/W/-wrk'
WORKON_HOME='/Users/W/-wrk/-ve'
VIRTUAL_ENV_NAME=''
VIRTUAL_ENV=''
_SRC=''
_APP=''
_WRD=''
_USRLOG='/Users/W/-usrlog.log'
_TERM_ID='#SElGeTf5VcA'
PATH='/Users/W/.local/bin:/Users/W/-dotfiles/scripts:/usr/sbin:/sbin:/bin:/usr/local/bin:/usr/bin:/opt/X11/bin:/usr/local/git/bin'
__DOTFILES='/Users/W/-dotfiles'
#
# cd /
#SElGeTf5VcA W@nb-mb1:/
$
$ stid 'dotfiles'
#stid  _TERM_ID="dotfiles"  #_TERM_ID__="dotfiles install"  #_USRLOG="/Users/W/-usrlog.log"
# stid 'dotfiles'
dotfiles W@nb-mb1:/
$

Upgrade the dotfiles

# check for any changes to symlinked dotfiles
cdd                                                   # cddotfiles
git status && git diff                                # gsi ; gitw diff

# pull and upgrade dotfiles and dotvim
scripts/bootstrap_dotfiles.sh -U

Quickstart

This is a verbose example of installing and working with a VIRTUAL_ENV in WORKON_HOME named "dotfiles".

See Install the dotfiles for more terse installation instructions.

# clone and install dotfiles and dotvim
# with venv-style paths (_SRC, _APP, _WRD)

# __WRK             -- base path for workspace               [venv]
__WRK="$HOME/-wrk"
cd $__WRK                     # cdwrk                        [venv]

# WORKON_HOME       -- path to virtualenv dirs  [virtualenvwrapper]
WORKON_HOME="${__WRK}/-ve27"  # ~/-wrk/-ve27
test -d ${WORKON_HOME} || mkdir -p ${WORKON_HOME}
cd $WORKON_HOME               # cdworkonhome cdwh cdve       [venv]

# VIRTUAL_ENV_NAME  -- basename for VIRTUAL_ENV              [venv]
VIRTUAL_ENV_NAME="dotfiles"

# VIRTUAL_ENV       -- current virtualenv path         [virtualenv]
VIRTUAL_ENV="${WORKON_HOME}/${VIRTUAL_ENV_NAME}"
cd $VIRTUAL_ENV               # cdv cdvirtualenv [venv, virtualenvwrapper]

# _SRC              -- basepath of source repositories (e.g. for pip) 
_SRC="${VIRTUAL_ENV}/src"
cd $_SRC                      # cdsrc cds                    [venv]

# _APP              -- basename of current working directory [venv]
_APP="dotfiles"

# _WRD              -- working directory path                [venv]
_WRD="${_SRC}/${_APP}"        # cdwrd cdw                    [venv]

git clone https://github.com/westurner/dotfiles $_WRD
git clone https://github.com/westurner/dotvim ${_WRD}/etc/vim
cd $_WRD                      # cdwrd cdw                    [venv]

# __DOTFILES        -- symlink root for current dotfiles     [venv]
__DOTFILES="${HOME}/-dotfiles"
ln -s $_WRD $__DOTFILES
ls ~/-dotfiles
cd $__DOTFILES                # cddotfiles cdd               [venv]

## Install the dotfiles
$_WRD/scripts/bootstrap_dotfiles.sh -h      # help
$_WRD/scripts/bootstrap_dotfiles.sh -I      # or: make install
$_WRD/scripts/bootstrap_dotfiles.sh -S      # or: make install_symlinks

For further documentation, see:

Further Dotfiles Resources

https://westurner.org/dotfiles/

dotfiles's People

Contributors

Stargazers

Watchers

Forkers

pombredanne mike-bales mihail-kostov rtk4616 maxkao karlfiner-robotiken

dotfiles's Issues

One!

DOC,ENH: Show rev history on GitHub sidebar link

BLD,BUG: regenerate MANIFEST.in from git before release

ENH,BUG: venv.py: set alternate __WRK path

venv --ve='dotfiles' --wrk="~/workspacez" [--print-bash | --print-vars]

BUG: lsusrlogs: list usrlogs from default WORKON_HOME/CONDA_ROOT

(WORKON_HOME__[py27|py34], CONDA_ROOT__[py27|py34])

ENH: _PYSITE="${HOME}/.local/lib/python${PYVER}/site-packages"

Add a _PYVER ENV variable
Set _PYSITE (site-packages) to ~/.local/lib/python${PYVER}/site-packages
by default

## PYVER: 'Python Version'
# PYVER = 'N.N'
PYVER = '2.7'
PYVER = '3.6'

ENH: _PYSITE="${HOME}/.local/lib/pythonN.N/site-packages"

ENH,BUG: venv.py: merge settings when -e/--from-environ && --app,--venvstr,--venstrapp

e.g. in ipython:

# this does not work (it's just --from-environ w/out the cmdline args)
!venv.py -e -xbash --venvstrapp=nbformat/nbformat

# workaround
!venv.py -xbash --venvstr=$VENVSTR --venvstrapp=nbformat

ENH: topo sort variables from self.environ

Algorithmic Solution (e.g. for testing, initially)

tokenize fmtstring vars (${varname} || {varname} || {{ varname }})
serialize to edges
tsort edges

Programmatic Solution

Venv.iter_environ() Defined .iterkeys output sequence for venv.env.environ OrderedDict (with known set of variables)

DOC,REF: venv.rst: venv_magics.py -> ipython_magics.py

DOC,ENH: Add searchbar to header

ENH: brew pip upgrade

Homebrew/legacy-homebrew#35194 (comment)

cp $_BIN/pip $_BIN/pip_
$_BIN/pip3 install -U pip
$_BIN/pip_ install -U pip

BUG,UBY: venv: deactivate resets WORKON_HOME to the default

venv is setting WORKON_HOME to the default set in venv.py.

Instead:

venv could set WORKON_HOME to os.environ.get('WORKON_HOME', opts.WORKON_HOME if opts.WORKON_HOME else default_workon_home) when: WORKON)

cases:

using venv.py for a prefix template
using venv.py for a virtualenv
using venv.py for a conda env
using venv.py with -E/--from-environ

DOC,BUG: make vim_help not showing in RTD

... Presumably because etc/vim is not cloned

Here: http://wrdfiles.readthedocs.org/en/latest/usage.html#vim

BUG: TYPO: disutils

Build failing: https://travis-ci.org/westurner/dotfiles/jobs/40649856

ENH,BUG: conda activate syntax

https://www.anaconda.com/blog/developer-blog/how-to-get-ready-for-the-release-of-conda-4-4/

TST: shell test cases

Test Framework Output Formats

POSIX return code

0 OK
1< # of test failures

XML-based output format
supported by e.g. jenkins
can be used for building charts of test performance over time

Testing Frameworks

https://en.wikipedia.org/wiki/List_of_unit_testing_frameworks

shunit2

LGPL, SVN

https://shunit2.googlecode.com/svn/trunk/source/2.1/doc/shunit2.html#abstract
https://www.sysorchestra.com/2014/10/12/travisshunit2/
curl -L "https://shunit2.googlecode.com/files/shunit2-2.1.6.tgz" | tar zx
git mirror (2011): https://github.com/zandev/shunit2

shunit2 xUnit output (e.g. for jenkins)

bashunit

BSD, GIT

https://github.com/djui/bashunit

ENH: lsaliases: (cd$x; ls $x$@) lswrk, lswrd; lsw, lssrc

ENH: lsaliases: ls cdaliases: lswrk

Existing functionality:

lsve; lsvirtualenvs  # ls -ld ~/-wrk/-ve??
lsce; lscondaenvs    # ls -ld ~/-wrk/-ce??

How it would work:

lswrk      # (cdwrk; ls "${@}")
lsw; lswrd # (cdw; ls "${@}")

REF: el.py -> vendored python package

el -- "edit lines" --> basically xargs with --each and Python str.format w/ shell quoting [TODO: repr adds a u'' to the front of [some versions of] [some] python3 strings]

BUG: Log output from [hg i] and [hg is] cannot colorize {desc}

...

see: Log templates with labels containing special characters error "parse error at 20:" http://bz.selenic.com/show_bug.cgi?id=4349:

Including a label() for desc when desc contains certain characters causes 'hg log' to error.

Steps to recreate::

# create a repo
mkdir repo; cd repo; echo 'Text' >> text
hg add text
hg commit -m "ENH: Add {git,hg} {i[s]} to log -n1 [and diffstat] (closes #3)"

# works
hg log -l1 --template "{label('custom.desc', node)}\n"

# errors
hg log -l1 --template "{label('custom.desc', desc)}\n"

Error Message:

hg: parse error at 20: syntax error

REF: git-changelog.py: factor to its own package

DOC,BLD: Sphinx >= 2.0 support

tell-k/sphinxjp.themes.basicstrap#25 fixes the app.info logging
- patch locally pending this getting merged
Now I'm getting sphinx.errors.ThemeError: no theme named 'basicstrap' found (missing theme.conf?)
- pip install requirements.txt does
  pip install -e git+ssh://github.com/tell-k/sphinxjp.themes.basicstrap#egg=basicstrap
- I've tried:
  - pip install -e .
  - pip install .

For now, the workaround is to:

pip install 'sphinx<2.0'

scripts/pyline.py -m pprint "pprint.pformat(locals())"

Add pp to pretty print the context

scripts/pyline.py 'pp(locals())'

This is okay because, for log interpretation, it's really more readable to use variables or cdaliases

cd ~ 
cd -wrk/    # ERR
cd ./-wrk/  # OK
cd $_WRK   # OK (venv --wrk="$HOME/-wrk")
cdwrk      # OK (venv cdaliases)
cdh -wrk/  # OK (venv cdaliases)

# env vars

__WRK="${HOME}/-wrk"
#WORKON_HOME="~/.virtualenvs"
WORKON_HOME="$__WRK/-ve27"  ## ~/-wrk/-ve27

VENVSTR=${1:-${VENVSTR}}
VENVSTR="dotfiles"  ## we dotfiles
VENVSTRAPP=${2:-${VENVSTRAPP:-${VENVSTR}}}

VIRTUAL_ENV_PREFIX="$VENVSTR"
VIRTUAL_ENV="$WORKON_HOME/$VIRTUAL_ENV_PREFIX"
_VENVPREFIX=$VIRTUAL_ENV
_SRC="$_VENVPREFIX/src"
_WRD="$_SRC/$_APP" 

## Create the __DOTFILES symlink to the current dotfiles repo:
__DOTFILES=~/-dotfiles
ln -s $_WRD $__DOTFILES

## Link to the venv script (also scripts/venv.py, etc/ipython/ipython_config.py)
__VENV="${__DOTFILES}/src/dotfiles/venv/ipython_config.py"

## Workon a venv (in `$WORKON_HOME` (or abspath($1)))
# we() {   ## bash function (we command)
#     source <($__VENV --print-bash $VENVSTR $VENVSTRAPP)
# }
## we dotfiles == we dotfiles dotfiles
we ${1:-${VENVSTR}} ${2:-${VENVSTRAPP:-${VENVSTR}}}
set -x;
[ "$_WRD" == "$WORKON_HOME/$VENVSTR/src/$VENVSTRAPP" ] || return 1

# dotfiles_status  # ds

tests
- unittest.TestCases
- ] [ shell test cases
venv "${1:-${VENVSTR}}" "${2:-${VENVSTRAPP:-${VENVSTR}}}"

tab handling (\t) differences between GNU and BSD programs
Bash HISTTIMEFORMAT

Possible remedies:

$'\t' ?

ENH: venv.vim: command-completion

" venv.vim
" :Cdwrd, :Cdsrc, :Cdetc completion

" help command-completion
" -complete=dir
" -complete=file (file or dir)
" -complete=function_name

function function_name
" cd to _DIR
" then -complete=dir
endfunction

| review: ef0197c#commitcomment-15236912

Impact:

lscondaenvs (lsce) may not list the current and default environments in natural order

REF: dotfiles.venv.py -> { venvw, venvv }, dotfiles -> dotfileswt

venv.py

westurner/dotfiles/scripts/venv.py can conflict with python3 -m venv

$ python3 -m venv
usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear] [--upgrade] [--without-pip]
            ENV_DIR [ENV_DIR ...]
venv: error: the following arguments are required: ENV_DIR

workaround:

python3 -m dotfiles,venv

TODO:

BLD: venvv [0.1.0?]: cookiecutter
ENH: venvv/venvv.py: from westurner/dotfiles/scripts/venv_ipyconfig.py

python -m venvv
python3 -m venvv

python -m dotfileswt.venvv
python3 -m dotfileswt.venvv

dotfileswt

setup.py APPNAME='dotfileswt'
grin+sed || vimgrep+ 'dotfiles[wt]'

_usrlogs=$(ls ~/.usrlog $WORKON_HOME/*/src/.usrlog)
usrlog-search-all() {
    term=$1
    grep $term ${_usrlogs}