Fabrice Quenneville
5ba0f84d12
This release introduces a major overhaul of the `mediacurator` command-line interface (CLI) and comprehensive updates to the documentation. The CLI has transitioned from a custom argument parsing system to utilizing Python's `argparse` and `argcomplete` libraries, greatly enhancing usability and flexibility. Due to these significant changes, the version is incremented from **0.0.13** to **1.0.1**. - **Refactored** `tools.py` for standardized command-line argument handling using `argparse` and `argcomplete`. - **Improved** user interaction with structured arguments and built-in help, error handling, and validation. - **Consolidated** video detail printing logic into a reusable method within the `Video` class. - **Enhanced** `MediaLibrary` class with better clarity, functionality, and expanded support for video formats. - **Reorganized** `main.py` to streamline argument handling and improve error feedback. - **Updated** `setup.py` for release preparation, including new classifiers and dependencies. - **Revised** README.md for clarity, including structured command usage and improved descriptions. - **Moved** and improved old documentation, removing outdated content and adding new screenshots. - **Maintained** legacy commands for backward compatibility while enhancing usability with clear examples. - **Removed** non-existent `bcolors` from the public API. - **Upgraded** requirements.txt to include `argcomplete` for command-line completion. - **Updated** docstrings and function documentation for clarity on functionality and parameters.
46 lines
1.1 KiB
ReStructuredText
46 lines
1.1 KiB
ReStructuredText
============
|
|
Installation
|
|
============
|
|
|
|
.. warning::
|
|
|
|
The following documentation is for versions prior to 1.0.1. It may contain features and usage instructions that are incompatible with the current version of mediacurator.
|
|
|
|
This package has been tested on GNU/Linux (e.g., Debian, Ubuntu, Fedora) and Windows, and requires FFmpeg to be installed. For now, it will be distributed on `GitHub <https://github.com/fabquenneville/mediacurator.git>`_.
|
|
|
|
Install FFmpeg
|
|
--------------
|
|
|
|
To install FFmpeg, you can follow the instructions for your platform:
|
|
|
|
- **On Debian and Ubuntu**:
|
|
.. code-block:: bash
|
|
|
|
sudo apt update
|
|
sudo apt install ffmpeg
|
|
|
|
- **On Fedora**:
|
|
.. code-block:: bash
|
|
|
|
sudo dnf install ffmpeg
|
|
|
|
- **On Windows**:
|
|
- Download the latest build from `FFmpeg <https://ffmpeg.org/download.html>`_.
|
|
- Follow the installation instructions provided on the site.
|
|
|
|
To verify your FFmpeg installation, you can run:
|
|
|
|
.. code-block:: bash
|
|
|
|
ffmpeg -version
|
|
|
|
|
|
Install from PyPi
|
|
-----------------
|
|
|
|
You can install the `mediacurator` package directly from PyPi using the following command:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install MediaCurator
|