https://github.com/lf-/polkadots
Personal dotfile manager
https://github.com/lf-/polkadots
dotfiles-manager python36
Last synced: about 2 months ago
JSON representation
Personal dotfile manager
- Host: GitHub
- URL: https://github.com/lf-/polkadots
- Owner: lf-
- License: mit
- Created: 2015-07-15T19:39:16.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2021-05-18T06:07:21.000Z (about 5 years ago)
- Last Synced: 2025-09-29T02:26:04.144Z (9 months ago)
- Topics: dotfiles-manager, python36
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Polkadots dotfile manager
=========================
This is a simple dotfile manager. You could use home-manager or other things,
but this is mine. Despite its simplicity, the deliberately Turing-complete
nature of its Python based config files allows for highly dynamic
behaviour.
How to use it
-------------
Install it:
~~~~~~~~~~~
``pip install polkadots-dotfile-manager``
For development:
``pip install --user -e .``
Make a polkadots config directory in .config/polkadots:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Basic example:
``~/.config/polkadots/config.py``:
.. code-block:: python
actions = [
SymlinkAction('aiopanel', '~/.config/aiopanel'),
SymlinkAction('main', '~', dir_mode=True),
]
``~/.config/polkadots/dotfile_repo``:
.. code-block:: text
~/.dotfiles
This configuration executes two actions. The first one symlinks the entire
aiopanel directory (files are also supported).
The second one goes through every item in the "main" folder in the
dotfile repo and symlinks them all into the destination directory. For
example, the file .vimrc in main would be symlinked to ~/.vimrc.
Run it:
~~~~~~~
``polkadots --config2 -v``
Options used:
- ``--config2`` -- enables the new python-based config format.
``-2`` is an alias for this.
- ``-v`` -- verbose logging