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.

Source Distribution

ezvi-0.1.4.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

ezvi-0.1.4-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file ezvi-0.1.4.tar.gz.

File metadata

  • Download URL: ezvi-0.1.4.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.2 Darwin/20.2.0

File hashes

Hashes for ezvi-0.1.4.tar.gz
Algorithm Hash digest
SHA256 031f98d891627a275114a344acd71102559aab942349d56525b08a739eb0e165
MD5 37ad7bf2b12d557206ced3f47cd786f3
BLAKE2b-256 43647d6328dac7fa2064f23c0a2671d5771ebd806ca77e0efa2a2f58fee58ee9

See more details on using hashes here.

File details

Details for the file ezvi-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ezvi-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.2 Darwin/20.2.0

File hashes

Hashes for ezvi-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3c62fccd77771870836bf7a540c38053b66200d4f5db165a9d85be837990f8c6
MD5 46c4c648aeb8f2274e5219ff7cd8c4d7
BLAKE2b-256 febbf7cb6832dacacbd27a803f4372e8b31ba53d1dfb81e905bccab70b023d9f

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