Dotpkg - Package manager for your dotfiles

Last update: Mar 18, 2022

Related tags

Package Management dotpkg

Overview

Dotpkg

A package manager for your dotfiles.

Usage

First make sure to have Python 3.9+ installed. To create a dotfile package, set up a folder with the following layout (the top-level folder is assumed to be some folder, e.g. a Git repo, where you store all of your dotfiles):

dotfiles
└─my-package
  ├─dotpkg.json
  ├─.some-dotfile-one
  ├─.some-dotfile-two
    ...

A minimal dotpkg.json is structured as follows:

{
  "name": "my-package",
  "description": "Description of my package"
}

Navigating into dotfiles and running dotpkg install my-package will then symlink .some-dotfile-one and .some-dotfile-two into your home directory.

Optionally, you can specify keys such as requiresOnPath too, which will only install the package if a given binary is found on your PATH (useful if your config targets some application). Additionally, targetDir configures the search path to symlink the files into some other directory than your home (dotpkg will use the first directory that exists, this is useful to cross-platform packages).

For example, a package that manages configurations for Visual Studio Code could look like this:

{
  "name": "vscode",
  "description": "Visual Studio Code settings and keybindings",
  "requiresOnPath": ["code"],
  "targetDir": [
    "${home}/.config/Code",
    "${home}/Library/Application Support/Code"
  ]
}

Comments

Add `init` and `new` commands

It would be cool to have an init command for dotpkg, roughly analogous to npm init that generates a template dotpkg.json for the user in the current directory.

Similarly, a new command that takes a name for a new dotpkg in a corresponding subdirectory like stack new, would be convenient.

dotpkg new my-package should be equivalent to (mkdir my-package && cd my-package && dotpkg init).
enhancement

opened by fwcd 0
Add support for subpackages/workspaces

It would be cool to have the ability to declare subpackages. A good use-case for this would be a dotfiles repo itself, since it usually hosts a bunch of such packages and natively supporting 'collections' of packages in the tool would obviate the need for custom installation scripts.
enhancement

opened by fwcd 0
Find better way of dealing with host-specific files

Perhaps using a directory structure like [package]/host/[hostname]/[file] instead of [package]/[file].[hostname] would be better since it's more generic, not as reliant on custom file-naming schemes, better to discover automatically (e.g. this schema wouldn't require declaring every host-specific file in the dotpkg.json), better supported in editors and on OSs like Windows that rely on file extensions?
enhancement

opened by fwcd 0
Add tests

Adding tests that verify that dotpkg links a few simple cases correctly (target file/folder present or not, etc.) would be great to make sure that we don't accidentally introduce regressions.
enhancement

opened by fwcd 0
Investigate making `dotpkg` a proper Python package

Adding the usual package structure makes it both installable with pip and easier to modularize. There is, however, quite a bit of convenience that is lost by no longer having a single executable file that can immediately be used after cloning and be moved anywhere. Perhaps a script that invokes python3 -m dotpkg could address this?
enhancement

opened by fwcd 0

Owner

FW

CS student with an interest in music, compilers, functional programming, math and more.

GitHub

OS-agnostic, system-level binary package manager and ecosystem

Conda is a cross-platform, language-agnostic binary package manager. It is the package manager used by Anaconda installations, but it may be used for

5.1k Jan 7, 2023

The Fast Cross-Platform Package Manager

The Fast Cross-Platform Package Manager part of mamba-org Package Manager mamba Package Server quetz Package Builder boa mamba Mamba is a reimplementa

4k Dec 30, 2022

Conan - The open-source C/C++ package manager

Conan Decentralized, open-source (MIT), C/C++ package manager. Homepage: https://conan.io/ Github: https://github.com/conan-io/conan Docs: https://doc

6.5k Jan 5, 2023

Package manager based on libdnf and libsolv. Replaces YUM.

Dandified YUM Dandified YUM (DNF) is the next upcoming major version of YUM. It does package management using RPM, libsolv and hawkey libraries. For m

1.1k Dec 26, 2022

A flexible package manager that supports multiple versions, configurations, platforms, and compilers.

Spack Spack is a multi-platform package manager that builds and installs multiple versions and configurations of software. It works on Linux, macOS, a

3.1k Jan 9, 2023

[DEPRECATED] YUM package manager

⛔ This project is deprecated. Please use DNF, the successor of YUM. YUM Yum is an automatic updater and installer for rpm-based systems. Included prog

111 Dec 20, 2022

Easy to use, fast, git sourced based, C/C++ package manager.

Yet Another C/C++ Package Manager Easy to use, fast, git sourced based, C/C++ package manager. Features No need to install a program, just include the

31 Dec 21, 2022

The delightful package manager for AppImages

⚡️ Zap The delightful package manager for AppImages Report bug · Request feature Looking for the older Zap v1 (Python) implementation? Head over to v1

368 Jan 4, 2023

:package: :fire: Python project management. Manage packages: convert between formats, lock, install, resolve, isolate, test, build graph, show outdated, audit. Manage venvs, build package, bump version.

THE PROJECT IS ARCHIVED Forks: https://github.com/orsinium/forks DepHell -- project management for Python. Why it is better than all other tools: Form

1.7k Dec 30, 2022

A software manager for easy development and distribution of Python code

Piper A software manager for easy development and distribution of Python code. The main features that Piper adds to Python are: Support for large-scal

13 Nov 22, 2022

Workon - A simple project manager for conda, windows 10 and vscode

WORK ON A simple project manager for conda, windows 10 and vscode Installation p

1 Jan 16, 2022

The Python Package Index

Warehouse Warehouse is the software that powers PyPI. See our development roadmap, documentation, and architectural overview. Getting Started You can

3.1k Jan 1, 2023

The Python package installer

pip - The Python Package Installer pip is the package installer for Python. You can use pip to install packages from the Python Package Index and othe

8.4k Dec 30, 2022

A Poetry plugin for dynamically extracting the package version.

Poetry Version Plugin A Poetry plugin for dynamically extracting the package version. It can read the version from a file __init__.py with: # __init__

264 Dec 22, 2022

PokerFace is a Python package for various poker tools.

PokerFace is a Python package for various poker tools. The following features are present in PokerFace... Types for cards and their componen

21 Dec 29, 2022

Example for how to package a Python library based on Cython.

Cython sample module This project is an example of a module that can be built using Cython. It is an upgrade from a similar model developed by Arin Kh

4 Aug 28, 2022

A set of tools to keep your pinned Python dependencies fresh.

pip-tools = pip-compile + pip-sync A set of command line tools to help you keep your pip-based packages fresh, even when you've pinned them. You do pi

6.5k Dec 29, 2022

A PDM plugin that packs your packages into a zipapp

pdm-packer A PDM plugin that packs your packages into a zipapp Requirements pdm-packer requires Python >=3.7 Installation If you have installed PDM wi

23 Dec 29, 2022

Install All Basic Termux Packages To Your Phone

~All-Packages~ The Easiest Way To Install All Termux Packages ?? Tool By ⒹⓈ᭄ʜʏᴅʀᴀ✘๛ˢᴸ ?? Contact Me On ?? >> AVAILABLE ON : Termux >> TESTED ON : Term

7 Nov 12, 2022