Skip to main content

The melding of docker compose and neovim

Project description

unholy

Cooperates with Docker Compose, injects an nvim-based container into it, and connects neovide to it.

You can call it what you'd like, but I'm going to call this union unholy.

Requirements

  • Unholy itself (I suggest using pipx)
  • Git
  • The Docker CLI
  • socat
  • Neovide

Usage

  1. Commit an Unholyfile to your repo (see below)
  2. Run unholy new <git url>
  3. Work on your project using unholy shell and unholy neovide

Use unholy remake to rebuild your development environment without re-cloning your repo or touching your work.

Note: By default, the name of the Unholy project is the repo name.

Unholyfile

A major aspect of unholy is the Unholyfile. It is a script with TOML head matter, like so:

---
[dev]
image="python"
---
pip install pytest

The complete headmatter schema is loosely documented in core.Unholyfile.

The script supports a #!, defaulting to #!/bin/sh

If you specify a non-default image, it must be Debian-based.

Additional config

Local configuration (including project definitions) are stored in the XDG Config directory (default ~/.config/unholy).

There is a global ~/.config/unholy/Unholy applied to all projects. This is an excellent place for personal settings (like utilities you like or nvim configuration).

Each project gets an ~/.config/<name>.Unholyfile where unholy keeps git and Docker settings. You can add some local project overrides 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

unholy-0.2.1.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

unholy-0.2.1-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file unholy-0.2.1.tar.gz.

File metadata

  • Download URL: unholy-0.2.1.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for unholy-0.2.1.tar.gz
Algorithm Hash digest
SHA256 8ff3c3cc26b960ea3b2fb7a8813d24f7e9a05fa8a3f126bd6493f32d19a48b14
MD5 7992b8311550dc73be86cdbeb91af246
BLAKE2b-256 6895038ed89456e12f2cb11ccea32d07f23b3429561abd704dfcafdfcd2ea701

See more details on using hashes here.

File details

Details for the file unholy-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: unholy-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for unholy-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 427fe31355045f12bda9ae945894e13ea4b1c8f939fff46cc82ca4a72e7b720b
MD5 e43ef196cb94b94159186a61f5594549
BLAKE2b-256 633ab3b4acb73341d793db66897e79290b5629c9ce6dc06c4d6b537e6b194c72

See more details on using hashes here.

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