Skip to main content

No project description provided

Project description

## dotpup manages dotfiles across platforms

This is very minimalistic and intended for my own usage, but maybe others
will find it useful. dotpup doesn't care about the synchronization of files,
it's up to you. You may use git, rsync, dropbox, nextcloud etc.

## Installation

```
$ pip install dotpup
```

## Usage

dotpup has three commands. All of them require setting DOTPUP_HOME. Typically,
you will want to have a dotfiles directory somewhere (I have `$HOME/dotfiles`).

You can start with an empty directory.

### dpup store

```
$ dpup store <some dotfile>
```

This moves the dotfile into `$DOTPUP_HOME`, symlinks it back to the original
location and records the transaction for future automated replication (see
`dpup update`)

This is my current dotpup.json:

```
{
"operations": {
"Darwin": {
".config/nvim/init.vim": "$HOME/.config/nvim/init.vim",
".gitconfig": "$HOME/.gitconfig",
".gitignore_global": "$HOME/.gitignore_global",
".tmux.conf": "$HOME/.tmux.conf",
".zsh_aliases": "$HOME/.zsh_aliases",
".zshrc": "$HOME/.zshrc"
},
"Linux": {
".config/nvim/init.vim": "$HOME/.config/nvim/init.vim",
".gitconfig": "$HOME/.gitconfig",
".gitignore_global": "$HOME/.gitignore_global",
".hosts": "$HOME/.hosts",
".ssh/config": "$HOME/.ssh/config",
".tmux.conf": "$HOME/.tmux.conf",
".zsh_aliases": "$HOME/.zsh_aliases",
".zshrc": "$HOME/.zshrc"
}
}
}
```

The reason for having per-platform entries is that the paths are not always the
same. For example, vscode (which I'm yet to add) uses different paths on Linux
and macOS.

### dpup link

```
$ dpup link <some stored dotfile> <target location>
```

This creates a symlink to a stored dotfile and records the operation. This is
typically useful when reusing dotfiles on a new platform.

### dpup update

```
$ dpup update
```

This performs the operations for the current platform or (optionally) for a
different platform. This is useful when you are setting up on a new machine.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dotpup-1.0.1.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dotpup-1.0.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file dotpup-1.0.1.tar.gz.

File metadata

  • Download URL: dotpup-1.0.1.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.4

File hashes

Hashes for dotpup-1.0.1.tar.gz
Algorithm Hash digest
SHA256 86bf34b43db0802c293f934a71cb356b6ad30d77218599496b0af9dbbf247177
MD5 459292a4618965e82fba7a05c5253b2c
BLAKE2b-256 d0c42e66f678a432963b48df59f5007835707a9d47bb9d1d05f84e044758fdd6

See more details on using hashes here.

File details

Details for the file dotpup-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: dotpup-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.4

File hashes

Hashes for dotpup-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1f35f4d87241ff53f788063cbff752640c6caf3afce0aadae5ce7bc21b63414
MD5 ad800fd615a089dd60f8cf2d2b59969f
BLAKE2b-256 17e0825c77c93276aeb93216633b6632261f858d009e10f1cb62f80919cda555

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page