# vimala
**Python library for working with command-line editors (like vim).**
_project status badges:_
[](https://github.com/bbugyi200/vimala/actions/workflows/ci.yml)
[](https://codecov.io/gh/bbugyi200/vimala)
[](https://vimala.readthedocs.io/en/latest/?badge=latest)
[](https://snyk.io/advisor/python/vimala)
_version badges:_
[](https://pypi.org/project/vimala/)
[](https://pypi.org/project/vimala/)
[](https://github.com/python-boltons/cc-python)
[](https://github.com/python-boltons/docker-python)
## Installation 🗹
To install `vimala` using [pip][9], run the following
commands in your terminal:
``` shell
python3 -m pip install --user vimala # install vimala
```
If you don't have pip installed, this [Python installation guide][10] can guide
you through the process.
<!-- [[[[[kooky.cog
from pathlib import Path
lines = Path("./docs/design/design.md").read_text().split("\n")
if any(L.strip() for L in lines):
fixed_lines = [L.replace("(.", "(./docs/design") if L.startswith("![") else L for L in lines]
print("## Design Diagrams\n")
print("\n".join(fixed_lines))
]]]]] -->
<!-- [[[[[end]]]]] -->
## Useful Links 🔗
* [API Reference][3]: A developer's reference of the API exposed by this
project.
* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.
Changes made to this cookiecutter are periodically synced with this project
using [cruft][12].
* [CHANGELOG.md][2]: We use this file to document all notable changes made to
this project.
* [CONTRIBUTING.md][7]: This document contains guidelines for developers
interested in contributing to this project.
* [Create a New Issue][13]: Create a new GitHub issue for this project.
* [Documentation][1]: This project's full documentation.
[1]: https://vimala.readthedocs.io/en/latest
[2]: https://github.com/bbugyi200/vimala/blob/master/CHANGELOG.md
[3]: https://vimala.readthedocs.io/en/latest/modules.html
[4]: https://github.com/python-boltons/cc-python
[5]: https://github.com/cookiecutter/cookiecutter
[6]: https://docs.readthedocs.io/en/stable/
[7]: https://github.com/bbugyi200/vimala/blob/master/CONTRIBUTING.md
[8]: https://github.com/bbugyi200/vimala
[9]: https://pip.pypa.io
[10]: http://docs.python-guide.org/en/latest/starting/installation/
[11]: https://github.com/pypa/pipx
[12]: https://github.com/cruft/cruft
[13]: https://github.com/bbugyi200/vimala/issues/new/choose
Raw data
{
"_id": null,
"home_page": "https://github.com/bbugyi200/vimala",
"name": "vimala",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Bryan M Bugyi",
"author_email": "bryanbugyi34@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/30/50/7ebe5e75aa5bbef70298999fea409aee61a00b9931903caf7f872e2c2b7c/vimala-0.2.0.tar.gz",
"platform": null,
"description": "# vimala\n\n**Python library for working with command-line editors (like vim).**\n\n_project status badges:_\n\n[](https://github.com/bbugyi200/vimala/actions/workflows/ci.yml)\n[](https://codecov.io/gh/bbugyi200/vimala)\n[](https://vimala.readthedocs.io/en/latest/?badge=latest)\n[](https://snyk.io/advisor/python/vimala)\n\n_version badges:_\n\n[](https://pypi.org/project/vimala/)\n[](https://pypi.org/project/vimala/)\n[](https://github.com/python-boltons/cc-python)\n[](https://github.com/python-boltons/docker-python)\n\n\n## Installation \ud83d\uddf9\n\nTo install `vimala` using [pip][9], run the following\ncommands in your terminal:\n\n``` shell\npython3 -m pip install --user vimala # install vimala\n```\n\nIf you don't have pip installed, this [Python installation guide][10] can guide\nyou through the process.\n\n<!-- [[[[[kooky.cog\nfrom pathlib import Path\n\nlines = Path(\"./docs/design/design.md\").read_text().split(\"\\n\")\nif any(L.strip() for L in lines):\n fixed_lines = [L.replace(\"(.\", \"(./docs/design\") if L.startswith(\"![\") else L for L in lines]\n print(\"## Design Diagrams\\n\")\n print(\"\\n\".join(fixed_lines))\n]]]]] -->\n<!-- [[[[[end]]]]] -->\n\n\n## Useful Links \ud83d\udd17\n\n* [API Reference][3]: A developer's reference of the API exposed by this\n project.\n* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.\n Changes made to this cookiecutter are periodically synced with this project\n using [cruft][12].\n* [CHANGELOG.md][2]: We use this file to document all notable changes made to\n this project.\n* [CONTRIBUTING.md][7]: This document contains guidelines for developers\n interested in contributing to this project.\n* [Create a New Issue][13]: Create a new GitHub issue for this project.\n* [Documentation][1]: This project's full documentation.\n\n\n[1]: https://vimala.readthedocs.io/en/latest\n[2]: https://github.com/bbugyi200/vimala/blob/master/CHANGELOG.md\n[3]: https://vimala.readthedocs.io/en/latest/modules.html\n[4]: https://github.com/python-boltons/cc-python\n[5]: https://github.com/cookiecutter/cookiecutter\n[6]: https://docs.readthedocs.io/en/stable/\n[7]: https://github.com/bbugyi200/vimala/blob/master/CONTRIBUTING.md\n[8]: https://github.com/bbugyi200/vimala\n[9]: https://pip.pypa.io\n[10]: http://docs.python-guide.org/en/latest/starting/installation/\n[11]: https://github.com/pypa/pipx\n[12]: https://github.com/cruft/cruft\n[13]: https://github.com/bbugyi200/vimala/issues/new/choose\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Python library for working with command-line editors (like vim).",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/bbugyi200/vimala"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "603e3e006e4966675e06768b69cc8ded7ed69b01dd51ebbfd68d057b933ba258",
"md5": "7452fc52033687c8fe79775ee774361d",
"sha256": "fded91ab2ada505a9a378d717055f685fcc61fc336aef79cb7d5bcb545d9b78a"
},
"downloads": -1,
"filename": "vimala-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7452fc52033687c8fe79775ee774361d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4196,
"upload_time": "2024-03-08T17:00:55",
"upload_time_iso_8601": "2024-03-08T17:00:55.194321Z",
"url": "https://files.pythonhosted.org/packages/60/3e/3e006e4966675e06768b69cc8ded7ed69b01dd51ebbfd68d057b933ba258/vimala-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30507ebe5e75aa5bbef70298999fea409aee61a00b9931903caf7f872e2c2b7c",
"md5": "2de8ab582bd83cad073d2761b5db1598",
"sha256": "1f541d14ce220a12db9a4a192ea3ff374d51470d6f4b0af6e2005bc9c6fdf413"
},
"downloads": -1,
"filename": "vimala-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2de8ab582bd83cad073d2761b5db1598",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 31046,
"upload_time": "2024-03-08T17:00:59",
"upload_time_iso_8601": "2024-03-08T17:00:59.964423Z",
"url": "https://files.pythonhosted.org/packages/30/50/7ebe5e75aa5bbef70298999fea409aee61a00b9931903caf7f872e2c2b7c/vimala-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 17:00:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bbugyi200",
"github_project": "vimala",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "bolton-eris",
"specs": [
[
"==",
"0.2.3"
]
]
},
{
"name": "bolton-ion",
"specs": [
[
"==",
"0.1.0"
]
]
},
{
"name": "bolton-metaman",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "bolton-proctor",
"specs": [
[
"==",
"0.2.2"
]
]
},
{
"name": "bolton-typist",
"specs": [
[
"==",
"0.2.0"
]
]
}
],
"tox": true,
"lcname": "vimala"
}