Skip to main content

Fast, easy, and automatic system configuration via a configuration file/repo

Project description

pydotfiles | Extendable Configuration-based Python Dotfile Manager

Build Status PyPI version Python 3.6+ semantic-release License

pydotfiles is an extendable and configurable dotfile manager written in python. It will configure your computer exactly the way that you want, and through the configuration system, means that people can have their own personalized environment by just editing configuration files, with no need to dive into the code to make it just work.

For Windows support, please see here

Features

  • Automatically sets up your applications, libraries, and environment the way YOU want
  • One-command installation
  • Easy configuration via forking and editing of a configuration file
  • Easy configuration options means that changes are simple and powerful
  • Enables unlimited extensions and customization, with a great baseline installation

Examples

  • Downloads a bunch of useful command-line tools (GNU tools, wget, bash v4+, vim, node, etc.)

  • [macOS only] Downloads a bunch of useful applications:

  • Secures and locks down the system via proper firewalling

  • Sets up proper dev environments (Python, Java, Ruby, Golang)

  • Sets up proper git environment with a better diff

  • [macOS only] Adds iTerm 2 shell integrations

Supported Platforms

  • macOS 10.12.x+ (High Sierra+)
  • Ubuntu 16.04 LTS

Installation

[RECOMMENDED] Opinionated Bootstrap

The following one-liner will bootstrap the system to an opinionated setup, in particular setting up pyenv for you if you don't have it yet, and setting up a new laptop-wide global python environment for day-to-day use.

Basically, if there's a completely new computer, run this:

curl -s https://raw.githubusercontent.com/JasonYao/pydotfiles/master/start-opinionated | bash -s {CONFIGURATION_REPO_GIT_LINK}
# e.g.
curl -s https://raw.githubusercontent.com/JasonYao/pydotfiles/master/start-opinionated | bash -s https://github.com/JasonYao/dotfiles.git

Non-Opinionated Bootstrap

The following one-liner won't assume the python environment that you're installing this to, and just install itself with pip.

Basically, if your computer already has the required python version/environments, run this:

curl -s https://raw.githubusercontent.com/JasonYao/pydotfiles/master/start-base | bash -s {CONFIGURATION_REPO_GIT_LINK}
# e.g.
curl -s https://raw.githubusercontent.com/JasonYao/pydotfiles/master/start-base | bash -s https://github.com/JasonYao/dotfiles.git

Usage

  • To toggle show/hiding of iTerm 2: +

  • To update + upgrade the dotfiles:

dotfiles upgrade
  • To uninstall the dotfiles:
dotfiles uninstall

License

This repo is licensed under the terms of the GNU GPL v3, of which a copy may be found here.

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

pydotfiles-4.2.8.tar.gz (63.5 kB view hashes)

Uploaded Source

Built Distribution

pydotfiles-4.2.8-py3-none-any.whl (93.8 kB view hashes)

Uploaded Python 3

Supported by

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