skip to navigation
skip to content

Not Logged In

linker 0.0.2

link files based on name

Latest Version: 0.1.0

linker is a tool for symlinking files based on the name of original file.

Why use linker?

linker takes a target directory and a destination directory as arguments, and links everything from the repo into its correct location, determined by the name of the target file. This allows you to track files in git, edit them in the place you would normally find them, and deploy your config quickly to new machines by cloning. Files common to all machines can be linked at the same time as config files unique to a specific host; all in the same repo.

See Example for further detail.

Usage

Usage: linker.py [options] target destination

Options:
  -h, --help            show this help message and exit
  -i, --interactive     Prompt for all changes
  -v, --verbose         Print all changes
  -d, --dry-run         Print all changes, but DON'T DO THEM
  -x, --exclude-common  default is to link files in `hostname` and 'common'
                        dirs. this will only link `hostname`
  --delete-existing     delete existing files instead of moving them to
                        original_name.back

Deterministic File Names

linker makes a few assumptions:

  • The git repo (or whatever else the target path happens to be) will have at least one folder in it, which matches the hostname of the machine linker is running on. This allows multiple machine configs to be kept in the same repo.
  • If a target file ends with “.dontlink” it should be tracked in the repo, but not linked by linker.
  • Underscores (_) in the target file should be replaced with slashes (/) in the symlink. This allows you to keep all the files for a single host in the same directory level of the repo, but be multiple levels deep where the link is made.
  • A double underscore in the target file is a literal underscore in the link name.
  • A file that starts with an underscore should be linked from /, not from the destination root.
  • If a directory named “common” exists at the same level as the hostname directory, those files should be linked, too. (This allows some files to link on all machines in the repo.)
  • If a file already exists, it should be backed up (moved to original_name.back), unless you explicity include --delete-existing.

Example

The user “user” keeps their dot files in a repo called “dotfiles” and they want to use linker on a machine called “hostname”.

  • /home/user/git/dotfiles
    • hostname
      • .vimrc
      • .vim_colors_color__scheme.vim
      • crontab_backup.dontlink
      • _etc_hosts
    • common
      • .bashrc

linker would make the following symlinks:

  • /home/user/.bashrc -> /home/user/git/dotfiles/common/.bashrc
  • /home/user/.vimrc -> /home/user/git/dotfiles/hostname/.vimrc
  • /home/user/vim/colors/color_scheme.vim -> /home/user/git/dotfiles/hostname/.vim_colors_color__scheme.vim
  • /etc/hosts -> /home/user/git/dotfiles/hostname/_etc_hosts

Notice crontab_backup.dontlink wasn’t linked anywhere.

To Do

See todo.md

 
File Type Py Version Uploaded on Size
linker-0.0.2.tar.gz (md5) Source 2014-03-23 4KB
  • Downloads (All Versions):
  • 21 downloads in the last day
  • 79 downloads in the last week
  • 410 downloads in the last month
  • Author: Charles Thomas
  • Home Page: https://github.com/charlesthomas/linker
  • License:
    The MIT License (MIT)
    
    Copyright (c) 2014 Charles Thomas
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
  • Package Index Owner: CharlesThomas
  • DOAP record: linker-0.0.2.xml