Skip to content
Astrality - A modular and dynamic configuration file manager
Python Other
  1. Python 98.9%
  2. Other 1.1%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
astrality
bin
docs
.coveragerc
.gitignore
.travis.yml
CHANGELOG.rst version: Bump version to 1.1.1 Nov 27, 2018
CONTRIBUTING.rst
CONTRIBUTORS.rst
LICENSE
MANIFEST.in
README.rst
conftest.py
mypy.ini
pytest.ini
requirements.in
requirements.txt
setup.cfg
setup.py

README.rst

Astrality logo Astrality - A Dynamic Configuration File Manager PyPI package Travis-CI Documentation Status Coveralls gitter

TL;DR: Automatically deploy dotfiles. Grouped into modules with dynamic behaviour.

What does it do?

Astrality is a flexible tool for managing configuration files, inspired by GNU Stow and Ansible.

Let's begin with a list of some of Astrality's key features:

  • Manage and deploy configuration files according to a central YAML config file.
  • Group related configuration into modules.
  • Conditionally enable modules based on environment variables, OS, installed programs and shell commands.
  • Copy and/or symlink files.
  • Execute shell commands.
  • Compile Jinja2 templates templates to target destinations.
  • Dynamically manipulate context values used during jinja2 compilation.
  • Automatically re-deploy dotfiles when source content is modified.
  • Subscribe to pre-defined events, such as local daylight, and execute actions accordingly.
  • Fetch modules from GitHub.
  • Restore files created and/or overwritten by modules.

Take a look at the tutorial for managing a dotfile repository, or see the full documentation for all available functionality. Feel free to drop by our Gitter room when getting started.

Here is gif demonstrating how Astrality is used to:

  1. Automatically change the desktop wallpaper based on the sun's position in the sky.
  2. Dynamically change the font size, and implicitly the bar height, of polybar.
  3. Simultaneously change the color scheme of alacritty, kitty, and polybar at the same time.

https://user-images.githubusercontent.com/10655778/36535609-934488ec-17ca-11e8-860e-4af5e1464997.gif

Getting started

Prerequisites

Astrality requires python 3.6 or greater. Check your version by running python --version.

Installation

astrality-git is published on the AUR for ArchLinux users. Otherwise, you can install Astrality using pip:

Create a new virtualenv for python 3.6 (or use your system python 3.6 if you prefer). Install Astrality from PyPI like so:

$ python3.6 -m pip install astrality

You should now be able to start astrality from your command line, but first, let us create an example configuration:

$ astrality --create-example-config

Take a look at the generated example configuration at ~/.config/astrality. Now start astrality:

$ astrality

Configuration and further documentation

I recommend taking a look at the full documentation of Astrality hosted at Read the Docs.

You can’t perform that action at this time.