============================
theatre-cli
============================
Overview
--------
theatre-cli is a powerful command-line tool written in Python that transforms your terminal into a personal movie theater. With theatre-cli, you can effortlessly watch your favorite movies stored locally on your device. It provides a seamless and immersive movie-watching experience right from the command line.
Features
--------
- Watch movies conveniently using a text-based interface.
- Supports popular media players like mpv_ and VLC_.
- Easy-to-use setup and configuration.
- Compatible with Python 3.10 and higher.
Installation
------------
Prerequisites
^^^^^^^^^^^^^^^^^
Before you can enjoy theatre-cli, ensure you have the following dependencies installed:
- Python 3.10 (or higher)
- mpv_
- VLC_
Installation Steps
^^^^^^^^^^^^^^^^^^^
1. Clone the repository:
.. code-block:: bash
git clone https://github.com/virajsazzala/theatre-cli.git
cd theatre-cli
2. Create a virtual environment:
.. code-block:: bash
python -m venv venv
source venv/bin/activate
3. Install requirements:
.. code-block:: bash
pip install -r requirements.txt
4. Install the package in editable mode:
.. code-block:: bash
pip install -e .
Usage
-----
1. Launch theatre-cli by running the command provided above.
2. Follow the on-screen instructions to set up your movie directory.
3. Enjoy your movies with a cinematic experience right from your terminal.
Contributions
-------------
Contributions to theatre-cli are welcome! Whether you want to add features, fix bugs, or improve documentation, feel free to fork the repository and submit a pull request.
.. _mpv: https://mpv.io/
.. _VLC: https://www.videolan.org/vlc/
Raw data
{
"_id": null,
"home_page": "https://github.com/virajsazzala/theatre-cli",
"name": "theatre-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "SNG Viraj Reddy",
"author_email": "vir200319@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/af/d1/a975fe6b2214fd47df942850c5582f6d9d27e380c71ef29d0848d39d85bd/theatre-cli-0.1.6.tar.gz",
"platform": null,
"description": "============================\ntheatre-cli\n============================\n\nOverview\n--------\n\ntheatre-cli is a powerful command-line tool written in Python that transforms your terminal into a personal movie theater. With theatre-cli, you can effortlessly watch your favorite movies stored locally on your device. It provides a seamless and immersive movie-watching experience right from the command line.\n\nFeatures\n--------\n\n- Watch movies conveniently using a text-based interface.\n- Supports popular media players like mpv_ and VLC_.\n- Easy-to-use setup and configuration.\n- Compatible with Python 3.10 and higher.\n\nInstallation\n------------\n\nPrerequisites\n^^^^^^^^^^^^^^^^^\n\nBefore you can enjoy theatre-cli, ensure you have the following dependencies installed:\n\n- Python 3.10 (or higher)\n- mpv_\n- VLC_\n\nInstallation Steps\n^^^^^^^^^^^^^^^^^^^\n\n1. Clone the repository:\n\n .. code-block:: bash\n \n git clone https://github.com/virajsazzala/theatre-cli.git\n cd theatre-cli\n\n2. Create a virtual environment:\n\n .. code-block:: bash\n\n python -m venv venv\n source venv/bin/activate\n\n3. Install requirements:\n\n .. code-block:: bash\n\n pip install -r requirements.txt\n\n4. Install the package in editable mode:\n\n .. code-block:: bash\n\n pip install -e .\n\nUsage\n-----\n\n1. Launch theatre-cli by running the command provided above.\n2. Follow the on-screen instructions to set up your movie directory.\n3. Enjoy your movies with a cinematic experience right from your terminal.\n\nContributions\n-------------\n\nContributions to theatre-cli are welcome! Whether you want to add features, fix bugs, or improve documentation, feel free to fork the repository and submit a pull request.\n\n.. _mpv: https://mpv.io/\n.. _VLC: https://www.videolan.org/vlc/\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line interface to play movies",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/virajsazzala/theatre-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "24750c9ed06d004f273e25543c3b243043f1931fd0726fe1da96bbc1ca9b4217",
"md5": "944d945afa74821bc4dc9de8e82a2f4a",
"sha256": "fd2d8ffbd0c55f58488f57d5919a4bf305134fae9742f03484bd410dfb2d15cd"
},
"downloads": -1,
"filename": "theatre_cli-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "944d945afa74821bc4dc9de8e82a2f4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5175,
"upload_time": "2024-02-03T23:26:49",
"upload_time_iso_8601": "2024-02-03T23:26:49.974466Z",
"url": "https://files.pythonhosted.org/packages/24/75/0c9ed06d004f273e25543c3b243043f1931fd0726fe1da96bbc1ca9b4217/theatre_cli-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "afd1a975fe6b2214fd47df942850c5582f6d9d27e380c71ef29d0848d39d85bd",
"md5": "ccfc68d0ac76ceda0df5e82f3038ade8",
"sha256": "3a205fa66c61826f4e02ae3eec0ff57d98df46e71a49e811c80246ae064d51ba"
},
"downloads": -1,
"filename": "theatre-cli-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "ccfc68d0ac76ceda0df5e82f3038ade8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4474,
"upload_time": "2024-02-03T23:26:52",
"upload_time_iso_8601": "2024-02-03T23:26:52.028791Z",
"url": "https://files.pythonhosted.org/packages/af/d1/a975fe6b2214fd47df942850c5582f6d9d27e380c71ef29d0848d39d85bd/theatre-cli-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 23:26:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "virajsazzala",
"github_project": "theatre-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "theatre-cli"
}