Skip to main content

Automated typing in the Vi editor.

Project description

ezvi

ezvi is a python package that allows typing automation for the Vi editor.

Installation

ezvi is distributed as a Pip package. To install the program, simply run

pip install ezvi

Usage

The package can be used via the CLI. ezvi functions can also be imported and used in a Python program.

The CLI

There are two different ways of using ezvi via the command line.

The text command

text can be used to type a pre-written file. It takes one argument (infile and one option (--writefile).

  • infile is the path towards the pre-written file.
  • --writefile tells the program to save the file again after typing it. --writefile takes one argument that corresponds to the path where the typed file will be written.
Example
ezvi text -w ./foo.txt example/message.txt

This takes the message.txt example from the example directory and types it again. The Vi buffer is then written to ./foo.txt.

The yaml command

yaml should be used to take a configuration as instructions to type a new file. The yaml command only takes one argument (config). Everything else should be specified in the config file.

  • config is the path towards the configuration file.
Example
ezvi yaml example/config.yaml

This command would take the config.yaml file from the example directory and use it to type a new file.

Writing a config file

A configuration file is just a yaml file that will be parsed using PyYAML. The structure of the file should be similar to the one in the config.yaml file from the example directory.

- write_line: "Hello!"
- new_line: 2
- write_chars: "-- Good Bot."
- write_file: "message.txt"
- quit_editor:

A - must precede every action.

Documentation

For more in depth documentation, please refer to the Read the Docs

Development

This package is in alpha. Not much testing has been done and many things could still change. To see the latest commit, go check the latest branch.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ezvi, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size ezvi-0.1.7-py3-none-any.whl (12.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ezvi-0.1.7.tar.gz (12.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page