axedit


Nameaxedit JSON
Version 0.1.7 PyPI version JSON
download
home_pageNone
SummaryAxedit is a modal text editor that attempts to implement vim-like motions
upload_time2025-10-16 16:37:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords editor
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
    <img src="https://github.com/blankRiot96/axedit/assets/77634274/d087fa6e-7225-45f9-b100-53df78a3000f" width=700><br>
    <a href=""><img src="https://img.shields.io/badge/License-MIT-green"></a>
    <a href=""><img src="https://img.shields.io/badge/Style-Black-black"></a>
    <a href=""><img src="https://img.shields.io/badge/Python-3.12-blue"></a>
    <a href=""><img src="https://img.shields.io/badge/Platforms-Windows, Mac, Linux-1E1E2E"></a>
    <a href=""><img src="https://img.shields.io/badge/Contributors-Welcome-A6E3A1"></a><br>
    <img src="https://github.com/blankRiot96/axedit/assets/77634274/b3e62314-2eb1-4ef9-860f-cfb640cd2b0c"><br>
</div>

## About

Axedit is a modal text editor for Python. Attempts to implement vim-like motions.

## Installation

```
pip install axedit
```

You can also install it with `pipx` or `uv`:
```
pipx install axedit
```
or
```
uv tool install axedit
```


## Usage

Run `axedit` in your project folder

## Features

### Provisions

- Linting offered with `ruff`. Tracks your `pyproject.toml` or `ruff.toml` for ruff specific configuration
- Autocompletions with `jedi`
- Syntax highlighting self implemented (for now)
- 20+ Themes available - Gruvbox, Catppuccin, One Dark, Rosepine etc.
- Font, Opacity, On Save hooks, Manner of squiggly lines and Theme are configurable. See [config.toml](https://github.com/blankRiot96/axedit/blob/main/axedit/assets/data/default_config/config.toml)
- Detects your Python environment based on the shell you launch `axedit` from and uses it accordingly for autocomplete

### Modal Bindings

| Keys  | Action      |
| ----- | ----------- |
| `i`   | Insert mode |
| `v`   | Visual mode |
| `ESC` | Normal mode |

### Cursor Motions

| Keys | Action                     |
| ---- | -------------------------- |
| `h`  | Move cursor left           |
| `l`  | Move cursor right          |
| `j`  | Move cursor down           |
| `k`  | Move cursor up             |
| `w`  | Move to the next word      |
| `{`  | Move to previous paragraph |
| `}`  | Move to next paragraph     |
| `0`  | Move to start of the line  |
| `$`  | Move to end of the line    |

### Editor Commands

| Command               | Action                                   |
| --------------------- | ---------------------------------------- |
| `:q[uit]`             | Quit the editor                          |
| `:w[rite]`            | Write the file                           |
| `:wq` or `:x`         | Write and quit the editor                |
| `:save[as] file-name` | Save the file as                         |
| `:rn` or `:rename`    | Rename the file                          |
| `:theme theme-name`   | Set the theme of the editor              |
| `:config`             | Open the config file                     |
| `:reset-config`       | Reset the editor's config to its default |
| `:reload-config`      | Apply the config                         |
| `:rel-no on/off`      | Set whether line no to be relative       |

## Credits

- [Matt](https://github.com/Matiiss) - For VCing with me and frankly solving major issues which would have delayed the release by months otherwise
- [Dylan](https://github.com/Dylan-DPC) - For always giving me direction on what to do
- Tim - For suggesting the idea of a modal text editor
- [Suyashtnt](https://github.com/Suyashtnt/) - For providing the [kleur](https://github.com/Suyashtnt/kleur) theme

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "axedit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "editor",
    "author": null,
    "author_email": "\"Axis (blankRiot96)\" <blankRiot96@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f5/a3/489d24e28d43333e501cb76f95298afcc6b8cb8d76e6028e369eba8ba235/axedit-0.1.7.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n    <img src=\"https://github.com/blankRiot96/axedit/assets/77634274/d087fa6e-7225-45f9-b100-53df78a3000f\" width=700><br>\n    <a href=\"\"><img src=\"https://img.shields.io/badge/License-MIT-green\"></a>\n    <a href=\"\"><img src=\"https://img.shields.io/badge/Style-Black-black\"></a>\n    <a href=\"\"><img src=\"https://img.shields.io/badge/Python-3.12-blue\"></a>\n    <a href=\"\"><img src=\"https://img.shields.io/badge/Platforms-Windows, Mac, Linux-1E1E2E\"></a>\n    <a href=\"\"><img src=\"https://img.shields.io/badge/Contributors-Welcome-A6E3A1\"></a><br>\n    <img src=\"https://github.com/blankRiot96/axedit/assets/77634274/b3e62314-2eb1-4ef9-860f-cfb640cd2b0c\"><br>\n</div>\n\n## About\n\nAxedit is a modal text editor for Python. Attempts to implement vim-like motions.\n\n## Installation\n\n```\npip install axedit\n```\n\nYou can also install it with `pipx` or `uv`:\n```\npipx install axedit\n```\nor\n```\nuv tool install axedit\n```\n\n\n## Usage\n\nRun `axedit` in your project folder\n\n## Features\n\n### Provisions\n\n- Linting offered with `ruff`. Tracks your `pyproject.toml` or `ruff.toml` for ruff specific configuration\n- Autocompletions with `jedi`\n- Syntax highlighting self implemented (for now)\n- 20+ Themes available - Gruvbox, Catppuccin, One Dark, Rosepine etc.\n- Font, Opacity, On Save hooks, Manner of squiggly lines and Theme are configurable. See [config.toml](https://github.com/blankRiot96/axedit/blob/main/axedit/assets/data/default_config/config.toml)\n- Detects your Python environment based on the shell you launch `axedit` from and uses it accordingly for autocomplete\n\n### Modal Bindings\n\n| Keys  | Action      |\n| ----- | ----------- |\n| `i`   | Insert mode |\n| `v`   | Visual mode |\n| `ESC` | Normal mode |\n\n### Cursor Motions\n\n| Keys | Action                     |\n| ---- | -------------------------- |\n| `h`  | Move cursor left           |\n| `l`  | Move cursor right          |\n| `j`  | Move cursor down           |\n| `k`  | Move cursor up             |\n| `w`  | Move to the next word      |\n| `{`  | Move to previous paragraph |\n| `}`  | Move to next paragraph     |\n| `0`  | Move to start of the line  |\n| `$`  | Move to end of the line    |\n\n### Editor Commands\n\n| Command               | Action                                   |\n| --------------------- | ---------------------------------------- |\n| `:q[uit]`             | Quit the editor                          |\n| `:w[rite]`            | Write the file                           |\n| `:wq` or `:x`         | Write and quit the editor                |\n| `:save[as] file-name` | Save the file as                         |\n| `:rn` or `:rename`    | Rename the file                          |\n| `:theme theme-name`   | Set the theme of the editor              |\n| `:config`             | Open the config file                     |\n| `:reset-config`       | Reset the editor's config to its default |\n| `:reload-config`      | Apply the config                         |\n| `:rel-no on/off`      | Set whether line no to be relative       |\n\n## Credits\n\n- [Matt](https://github.com/Matiiss) - For VCing with me and frankly solving major issues which would have delayed the release by months otherwise\n- [Dylan](https://github.com/Dylan-DPC) - For always giving me direction on what to do\n- Tim - For suggesting the idea of a modal text editor\n- [Suyashtnt](https://github.com/Suyashtnt/) - For providing the [kleur](https://github.com/Suyashtnt/kleur) theme\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Axedit is a modal text editor that attempts to implement vim-like motions",
    "version": "0.1.7",
    "project_urls": {
        "Homepage": "https://github.com/blankRiot96/axedit",
        "Issues": "https://github.com/blankRiot96/axedit/issues",
        "Repository": "https://github.com/blankRiot96/axedit"
    },
    "split_keywords": [
        "editor"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "24772f6cffabbcb609011477fb21d86efa2234694a356d126e0dcb2e504df6e6",
                "md5": "3ae35c5062ddca5a162ac33d474b207d",
                "sha256": "3da6deba182ae4c9b428be81e47ef81a67ee62a20cac78b81bf6cad3625ed5d6"
            },
            "downloads": -1,
            "filename": "axedit-0.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ae35c5062ddca5a162ac33d474b207d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 1095128,
            "upload_time": "2025-10-16T16:37:10",
            "upload_time_iso_8601": "2025-10-16T16:37:10.690505Z",
            "url": "https://files.pythonhosted.org/packages/24/77/2f6cffabbcb609011477fb21d86efa2234694a356d126e0dcb2e504df6e6/axedit-0.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f5a3489d24e28d43333e501cb76f95298afcc6b8cb8d76e6028e369eba8ba235",
                "md5": "654457e06aabd5f84465faedc2c9ea5d",
                "sha256": "cfe9717ad8e5f8b96a9b844317c8bc67f30cb3357bb28fb78218d0ae491ac8f2"
            },
            "downloads": -1,
            "filename": "axedit-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "654457e06aabd5f84465faedc2c9ea5d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 1081943,
            "upload_time": "2025-10-16T16:37:12",
            "upload_time_iso_8601": "2025-10-16T16:37:12.768089Z",
            "url": "https://files.pythonhosted.org/packages/f5/a3/489d24e28d43333e501cb76f95298afcc6b8cb8d76e6028e369eba8ba235/axedit-0.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-16 16:37:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "blankRiot96",
    "github_project": "axedit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "axedit"
}
        
Elapsed time: 1.77361s