pyinkr


Namepyinkr JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryA tool for managing MKV files
upload_time2025-09-05 18:34:52
maintainerNone
docs_urlNone
authorxMohnad
requires_python>=3.9
licenseNone
keywords terminal
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Inkr - MKV Editor

Inkr is a simple tool for managing MKV files.

## Installation

### Prerequisites

- **MKVToolNix**: Required for MKV operations. Install using your package manager:

  | Platform | Command |
  |----------|---------|
  | **Arch Linux** | `sudo pacman -S mkvtoolnix-cli` |
  | **Debian/Ubuntu** | `sudo apt install mkvtoolnix` |
  | **macOS** (Homebrew) | `brew install mkvtoolnix` |
  | **Termux** | `pkg install mkvtoolnix` |
  | **Windows** | [Download installer](https://mkvtoolnix.download/downloads.html#windows) |

### Install Inkr

#### Recommended Method (using pipx)

```bash
pipx install pyinkr
```

*Why pipx?*

- Isolates the application in its own environment
- Prevents dependency conflicts
- Easier to uninstall/update

#### Alternative Method (using pip)

```bash
pip install pyinkr
```

> [!NOTE]
> To run the application, use the `inkr` command.

### For Developers

1. Clone the repository:

   ```bash
   git clone https://github.com/xMohnad/Inkr.git
   cd Inkr
   ```

1. Set up development environment:

   ```bash
   make setup

   # run application
   make run
   ```

## Key Bindings

Press `Ctrl+p` to open the command palette
and view all available key bindings.

## Dependencies

- [Textual](https://textual.textualize.io/): A Python framework for building terminal-based user interfaces.
- [pymkv2](https://github.com/GitBib/pymkv2): A Python wrapper for the MKVToolNix utilities.
- [Textual-Fspicker](https://github.com/davep/textual-fspicker): A Textual widget library for picking things in the filesystem

## Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss the proposed changes.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyinkr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "terminal",
    "author": "xMohnad",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/22/ae/bf1aebc1fc33996774c26fe450f9699b3a104988d4f29337748d8522d61c/pyinkr-0.2.0.tar.gz",
    "platform": null,
    "description": "# Inkr - MKV Editor\n\nInkr is a simple tool for managing MKV files.\n\n## Installation\n\n### Prerequisites\n\n- **MKVToolNix**: Required for MKV operations. Install using your package manager:\n\n  | Platform | Command |\n  |----------|---------|\n  | **Arch Linux** | `sudo pacman -S mkvtoolnix-cli` |\n  | **Debian/Ubuntu** | `sudo apt install mkvtoolnix` |\n  | **macOS** (Homebrew) | `brew install mkvtoolnix` |\n  | **Termux** | `pkg install mkvtoolnix` |\n  | **Windows** | [Download installer](https://mkvtoolnix.download/downloads.html#windows) |\n\n### Install Inkr\n\n#### Recommended Method (using pipx)\n\n```bash\npipx install pyinkr\n```\n\n*Why pipx?*\n\n- Isolates the application in its own environment\n- Prevents dependency conflicts\n- Easier to uninstall/update\n\n#### Alternative Method (using pip)\n\n```bash\npip install pyinkr\n```\n\n> [!NOTE]\n> To run the application, use the `inkr` command.\n\n### For Developers\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/xMohnad/Inkr.git\n   cd Inkr\n   ```\n\n1. Set up development environment:\n\n   ```bash\n   make setup\n\n   # run application\n   make run\n   ```\n\n## Key Bindings\n\nPress `Ctrl+p` to open the command palette\nand view all available key bindings.\n\n## Dependencies\n\n- [Textual](https://textual.textualize.io/): A Python framework for building terminal-based user interfaces.\n- [pymkv2](https://github.com/GitBib/pymkv2): A Python wrapper for the MKVToolNix utilities.\n- [Textual-Fspicker](https://github.com/davep/textual-fspicker): A Textual widget library for picking things in the filesystem\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss the proposed changes.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A tool for managing MKV files",
    "version": "0.2.0",
    "project_urls": {
        "Discussions": "https://github.com/xMohnad/Inkr/discussions",
        "Homepage": "https://github.com/xMohnad/Inkr",
        "Issues": "https://github.com/xMohnad/Inkr/issues",
        "Repository": "https://github.com/xMohnad/Inkr"
    },
    "split_keywords": [
        "terminal"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "118fda0842ebcbe8c44799232254b8483f26c7268bdf12eaccd0549e3f4c502e",
                "md5": "47b0ff47e8a2d3c6ed939ee7f5909dd9",
                "sha256": "e1aa3d2446867384c1f589a464d281f4979aa80c8380b2d1e98101ca09b0c761"
            },
            "downloads": -1,
            "filename": "pyinkr-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "47b0ff47e8a2d3c6ed939ee7f5909dd9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 8253,
            "upload_time": "2025-09-05T18:34:50",
            "upload_time_iso_8601": "2025-09-05T18:34:50.809985Z",
            "url": "https://files.pythonhosted.org/packages/11/8f/da0842ebcbe8c44799232254b8483f26c7268bdf12eaccd0549e3f4c502e/pyinkr-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "22aebf1aebc1fc33996774c26fe450f9699b3a104988d4f29337748d8522d61c",
                "md5": "9e2f594ef341804e82282ba54739b2e6",
                "sha256": "e9164b703f3cdc83fbcb7562d806f65d9ca5745ad553f43976d574a680d533b8"
            },
            "downloads": -1,
            "filename": "pyinkr-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9e2f594ef341804e82282ba54739b2e6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5931,
            "upload_time": "2025-09-05T18:34:52",
            "upload_time_iso_8601": "2025-09-05T18:34:52.176538Z",
            "url": "https://files.pythonhosted.org/packages/22/ae/bf1aebc1fc33996774c26fe450f9699b3a104988d4f29337748d8522d61c/pyinkr-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-05 18:34:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "xMohnad",
    "github_project": "Inkr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyinkr"
}
        
Elapsed time: 4.26026s