vimiv


Namevimiv JSON
Version 0.9.0 PyPI version JSON
download
home_pagehttps://karlch.github.io/vimiv-qt/
SummaryAn image viewer with vim-like keybindings.
upload_time2023-07-15 15:19:50
maintainer
docs_urlNone
authorChristian Karl
requires_python>=3.8
licenseGPL3
keywords pyqt image viewer vim
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            <img src="https://karlch.github.io/vimiv-qt/_images/vimiv_banner_800.png" alt="vimiv banner" width="400"/>

[![Build Status](https://github.com/karlch/vimiv-qt/workflows/CI/badge.svg)](https://github.com/karlch/vimiv-qt/actions)
[![Codecov](https://codecov.io/github/karlch/vimiv-qt/coverage.svg?branch=master)](https://codecov.io/github/karlch/vimiv-qt?branch=master)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

[website](https://karlch.github.io/vimiv-qt/) |
[docs](https://karlch.github.io/vimiv-qt/documentation/index.html) |
[install](https://karlch.github.io/vimiv-qt/documentation/install.html) |
[screenshots](https://karlch.github.io/vimiv-qt/screenshots.html) |
[changelog](https://karlch.github.io/vimiv-qt/changelog.html) |
[contributing](https://karlch.github.io/vimiv-qt/documentation/contributing.html)

<img src="https://i.postimg.cc/VkcPgcbR/vimiv.gif" alt="vimiv screencast" width="440"/>

---
> :information_source: This Qt port is the future of vimiv. New features will
> only be implemented here and there are already many improvements compared to the
> [deprecated gtk version](https://github.com/karlch/vimiv). The old version is only
> recommended if you require a more stable software. In case there is anything you miss
> here, please [open an issue](https://github.com/karlch/vimiv-qt/issues). Check the
> [roadmap](https://karlch.github.io/vimiv-qt/roadmap.html) for more details.
---

Vimiv is an image viewer with vim-like keybindings. It is written in python3
using the Qt5 toolkit and is free software, licensed under the GPL.

### Features

* Basic image operations and navigation
* [ranger](https://github.com/ranger/ranger)-like library to browse your images
* Thumbnail mode: navigable grid of image previews
* Command mode with tab-completion
* Search with pattern matching
* Simple mark and tag system
* Customization of keybindings, settings and style via configuration files,
  [base-16 support](https://github.com/karlch/base16-vimiv), ...

### Install

To learn how to get vimiv running on various platforms, please check out the
[installation guide](https://karlch.github.io/vimiv-qt/documentation/install.html).

### Documentation

Much more details on vimiv are available on the
[website](https://karlch.github.io/vimiv-qt/). Here are some hints to get you started:
* [The installation guide](https://karlch.github.io/vimiv-qt/documentation/install.html)
   includes instructions on how to get vimiv running on various platforms.
* [Getting started](https://karlch.github.io/vimiv-qt/documentation/getting\_started.html)
  starts with the basic concepts and keybindings to later show some more advanced
  features.
* [Commands](https://karlch.github.io/vimiv-qt/documentation/commands.html)
  gives a complete overview and description of all commands.
* [Keybindings](https://karlch.github.io/vimiv-qt/documentation/configuration/keybindings.html)
  lists the default keybindings and describes how to configure them.
* [Settings](https://karlch.github.io/vimiv-qt/documentation/configuration/settings.html)
  describes the available settings and how to change them.
* [Style](https://karlch.github.io/vimiv-qt/documentation/configuration/style.html)
  explains how to configure the look and colorscheme of vimiv.
* [Plugins](https://karlch.github.io/vimiv-qt/documentation/configuration/plugins.html)
  illustrates vimiv's python plugin system: a great way to extend the functionality
  beyond the defaults and to start delving into the source code.

### Contributing

You want to contribute to vimiv? Great! :tada:

Every little help counts and is appreciated!  Feel free to read the
[contributing guidelines](https://karlch.github.io/vimiv-qt/documentation/contributing.html)
for some useful tips and tricks.

There are many ways to contribute, including:
* [giving feedback and requesting new features](https://karlch.github.io/vimiv-qt/documentation/contributing.html#feedback-and-feature-requests)
* [reporting bugs](https://karlch.github.io/vimiv-qt/documentation/contributing.html#reporting-bugs)
* [writing code](https://karlch.github.io/vimiv-qt/documentation/contributing.html#writing-code)
* [extending the documentation](https://karlch.github.io/vimiv-qt/documentation/contributing.html#writing-documentation)
* spreading the word in an article, blog, reddit post, ...

Need help? Feel free to
[contact me directly](mailto:karlch@protonmail.com)
or, even better,
open an [issue on github](https://github.com/karlch/vimiv-qt/issues/).

### License

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <http://www.gnu.org/licenses/>.

            

Raw data

            {
    "_id": null,
    "home_page": "https://karlch.github.io/vimiv-qt/",
    "name": "vimiv",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "pyqt,image viewer,vim",
    "author": "Christian Karl",
    "author_email": "karlch@protonmail.com",
    "download_url": "https://files.pythonhosted.org/packages/06/e6/0ffc781a77784d1a70d44d3223fc0286c32ae883832094b8e8c540c8a30d/vimiv-0.9.0.tar.gz",
    "platform": null,
    "description": "<img src=\"https://karlch.github.io/vimiv-qt/_images/vimiv_banner_800.png\" alt=\"vimiv banner\" width=\"400\"/>\n\n[![Build Status](https://github.com/karlch/vimiv-qt/workflows/CI/badge.svg)](https://github.com/karlch/vimiv-qt/actions)\n[![Codecov](https://codecov.io/github/karlch/vimiv-qt/coverage.svg?branch=master)](https://codecov.io/github/karlch/vimiv-qt?branch=master)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n[website](https://karlch.github.io/vimiv-qt/) |\n[docs](https://karlch.github.io/vimiv-qt/documentation/index.html) |\n[install](https://karlch.github.io/vimiv-qt/documentation/install.html) |\n[screenshots](https://karlch.github.io/vimiv-qt/screenshots.html) |\n[changelog](https://karlch.github.io/vimiv-qt/changelog.html) |\n[contributing](https://karlch.github.io/vimiv-qt/documentation/contributing.html)\n\n<img src=\"https://i.postimg.cc/VkcPgcbR/vimiv.gif\" alt=\"vimiv screencast\" width=\"440\"/>\n\n---\n> :information_source: This Qt port is the future of vimiv. New features will\n> only be implemented here and there are already many improvements compared to the\n> [deprecated gtk version](https://github.com/karlch/vimiv). The old version is only\n> recommended if you require a more stable software. In case there is anything you miss\n> here, please [open an issue](https://github.com/karlch/vimiv-qt/issues). Check the\n> [roadmap](https://karlch.github.io/vimiv-qt/roadmap.html) for more details.\n---\n\nVimiv is an image viewer with vim-like keybindings. It is written in python3\nusing the Qt5 toolkit and is free software, licensed under the GPL.\n\n### Features\n\n* Basic image operations and navigation\n* [ranger](https://github.com/ranger/ranger)-like library to browse your images\n* Thumbnail mode: navigable grid of image previews\n* Command mode with tab-completion\n* Search with pattern matching\n* Simple mark and tag system\n* Customization of keybindings, settings and style via configuration files,\n  [base-16 support](https://github.com/karlch/base16-vimiv), ...\n\n### Install\n\nTo learn how to get vimiv running on various platforms, please check out the\n[installation guide](https://karlch.github.io/vimiv-qt/documentation/install.html).\n\n### Documentation\n\nMuch more details on vimiv are available on the\n[website](https://karlch.github.io/vimiv-qt/). Here are some hints to get you started:\n* [The installation guide](https://karlch.github.io/vimiv-qt/documentation/install.html)\n   includes instructions on how to get vimiv running on various platforms.\n* [Getting started](https://karlch.github.io/vimiv-qt/documentation/getting\\_started.html)\n  starts with the basic concepts and keybindings to later show some more advanced\n  features.\n* [Commands](https://karlch.github.io/vimiv-qt/documentation/commands.html)\n  gives a complete overview and description of all commands.\n* [Keybindings](https://karlch.github.io/vimiv-qt/documentation/configuration/keybindings.html)\n  lists the default keybindings and describes how to configure them.\n* [Settings](https://karlch.github.io/vimiv-qt/documentation/configuration/settings.html)\n  describes the available settings and how to change them.\n* [Style](https://karlch.github.io/vimiv-qt/documentation/configuration/style.html)\n  explains how to configure the look and colorscheme of vimiv.\n* [Plugins](https://karlch.github.io/vimiv-qt/documentation/configuration/plugins.html)\n  illustrates vimiv's python plugin system: a great way to extend the functionality\n  beyond the defaults and to start delving into the source code.\n\n### Contributing\n\nYou want to contribute to vimiv? Great! :tada:\n\nEvery little help counts and is appreciated!  Feel free to read the\n[contributing guidelines](https://karlch.github.io/vimiv-qt/documentation/contributing.html)\nfor some useful tips and tricks.\n\nThere are many ways to contribute, including:\n* [giving feedback and requesting new features](https://karlch.github.io/vimiv-qt/documentation/contributing.html#feedback-and-feature-requests)\n* [reporting bugs](https://karlch.github.io/vimiv-qt/documentation/contributing.html#reporting-bugs)\n* [writing code](https://karlch.github.io/vimiv-qt/documentation/contributing.html#writing-code)\n* [extending the documentation](https://karlch.github.io/vimiv-qt/documentation/contributing.html#writing-documentation)\n* spreading the word in an article, blog, reddit post, ...\n\nNeed help? Feel free to\n[contact me directly](mailto:karlch@protonmail.com)\nor, even better,\nopen an [issue on github](https://github.com/karlch/vimiv-qt/issues/).\n\n### License\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU General Public License as published by the Free Software\nFoundation, either version 3 of the License, or (at your option) any later\nversion.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with\nthis program. If not, see <http://www.gnu.org/licenses/>.\n",
    "bugtrack_url": null,
    "license": "GPL3",
    "summary": "An image viewer with vim-like keybindings.",
    "version": "0.9.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/karlch/vimiv-qt/issues",
        "Documentation": "https://karlch.github.io/vimiv-qt/documentation",
        "Homepage": "https://karlch.github.io/vimiv-qt/",
        "Source Code": "https://github.com/karlch/vimiv-qt"
    },
    "split_keywords": [
        "pyqt",
        "image viewer",
        "vim"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06e60ffc781a77784d1a70d44d3223fc0286c32ae883832094b8e8c540c8a30d",
                "md5": "cedcd0923dca6ed12d9de844875f571e",
                "sha256": "de686cbe878f8e663e5d236e8ad488a000a1e003aa91b9f25d3e3c37b235363e"
            },
            "downloads": -1,
            "filename": "vimiv-0.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cedcd0923dca6ed12d9de844875f571e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 231884,
            "upload_time": "2023-07-15T15:19:50",
            "upload_time_iso_8601": "2023-07-15T15:19:50.032873Z",
            "url": "https://files.pythonhosted.org/packages/06/e6/0ffc781a77784d1a70d44d3223fc0286c32ae883832094b8e8c540c8a30d/vimiv-0.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-15 15:19:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "karlch",
    "github_project": "vimiv-qt",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "vimiv"
}
        
Elapsed time: 0.09030s