Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeffrey-xiao/dotinstall
https://github.com/jeffrey-xiao/dotinstall
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/jeffrey-xiao/dotinstall
- Owner: jeffrey-xiao
- License: apache-2.0
- Created: 2017-05-06T01:42:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T12:37:21.000Z (about 2 years ago)
- Last Synced: 2024-11-28T05:36:27.031Z (about 2 months ago)
- Language: Python
- Size: 1.02 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# dotinstall
[](https://travis-ci.org/travis-ci/travis-web) [](https://codecov.io/gh/jeffrey-xiao/dotinstall)
[](https://badge.fury.io/py/dotinstall)
[](https://opensource.org/licenses/MIT)
[](https://opensource.org/licenses/Apache-2.0)
`dotinstall` makes it easier to completely setup a fresh install. By grouping your configs into
'packages', you can use `dotinstall` to quickly symlink your files, install dependencies, and setup
your system. You might have a particularly hard time setting up your windows manager. For example, I
use i3-gaps and i3blocks-gaps on Ubuntu so I have to install those from source. By having a package
defined as i3, I can associate dependencies and scripts to run to setup my windows manager.
Features:
- Easy integration into existing dotfiles by installing as submodules.
- Association of dependencies with packages.
- Globbing for specifying targets to symlink in each package.
- Prelink, and postlink scripts to run before symlinking and dependency installation.
- Easy configuration setup using yaml.
## Installation
```
mkdir dotfiles
cd dotfiles
pip3 install dotinstall
dotinstall
```
## Usage
Run `dotinstall -h` for more details.
## Config File
The config file (default `config.yaml`) has the following possible entries.
**link**: If specified as an item, it will link all the items in the package to the specified
location. If specified as a list, it will link the specific items to their specified location. Note
that each item will at most be linked once. For example, if you have three files `1.txt`,
`2.txt`, `3.txt` and you first link `1.txt`, it will only link `2.txt` and
`3.txt` when you later try to link `*.txt`.
**prelink**: A list of scripts that will run before dependency installation and linking.
**postlink**: A list of scripts that will run after dependency installation and linking.
**dependencies**: A list of dependencies of each package that will be installed by the detected
package manager. Dependency installation will occur before linking.
**overwrite**: If true (default), the symlinking will forcibly remove existing files, symlinks, and
directories.
**clean**: If true (default), dotinstall will remove all broken symlinks in all target directories.
The order of the commands will be: prelink -> dependencies -> link -> postlink -> clean.
Each submodule will be installed in the order that it is listed in the config file.
## Example
Please see my personal dotfile
[config](https://github.com/jeffrey-xiao/dotfiles/blob/master/config.yaml).
## Contributing
Please fork the repository and submit a PR. New plugins are very easy to create, by adding a new
class with a `execute` command.
Currently implemented package managers are:
- `apt-get`
- `brew`
- `pacman`
- `eopkg`
Feel free to add other package managers.
## License
`dotinstall` is dual-licensed under the terms of either the MIT License or the Apache License
(Version 2.0).
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for more details.