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
  • 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.1.0.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

unholy-0.1.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for unholy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 942fc419773119adc6b495067a32d1ff52801cc8cfe70ebde62aa6aeddb51bf6
MD5 50440c79ed40a71c42ebd9f8af569366
BLAKE2b-256 041914a9b778d8716dbe166845fcc95460084ff1b001b0cfde41f8f8ca5d66b3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for unholy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fcd0929729f1c45ff1a8bdbb63d3db05ffa81a5305b57650351962fb9f7a7759
MD5 32b09f45a65a225e6b845bf0af627562
BLAKE2b-256 ee835f6342762c40c9f3b146a6ba8f7ebc03f63b1e0f1be3d0b3a661e5dae03d

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