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.
87 lines
2.2 KiB
ReStructuredText
87 lines
2.2 KiB
ReStructuredText
========================================
|
|
Welcome to mediacurator's documentation!
|
|
========================================
|
|
|
|
mediacurator is a Python command line tool to manage a media database.
|
|
|
|
* List all the videos and their information with or without filters
|
|
* Batch find and repair/convert videos with encoding errors
|
|
* Batch recode videos to more modern codecs (x265 / AV1) based on filters: extensions, codecs, resolutions ...
|
|
|
|
The source code can be found on `GitHub <https://github.com/fabquenneville/mediacurator>`_
|
|
|
|
.. warning::
|
|
|
|
**Breaking changes in version 1.0.1:**
|
|
|
|
Starting with version 1.0.1, the command-line interface (CLI) has undergone major changes, and the usage is **not backwards-compatible** with previous versions.
|
|
|
|
If you are using `mediacurator < 1.0.1`, please refer to the legacy documentation available below (:ref:`legacy_docs`).
|
|
|
|
----------------------------------------
|
|
Documentation
|
|
----------------------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Usage:
|
|
|
|
usage/warnings
|
|
usage/installation
|
|
usage/quickstart
|
|
usage/manual
|
|
usage/use_cases
|
|
usage/errors
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Release Notes:
|
|
|
|
releasenotes/1.0.1-changelog
|
|
|
|
----
|
|
|
|
.. _legacy_docs:
|
|
|
|
----------------------------------------
|
|
Legacy Documentation (Pre 1.0)
|
|
----------------------------------------
|
|
|
|
.. 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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Legacy Usage:
|
|
|
|
legacy_usage/warnings
|
|
legacy_usage/installation
|
|
legacy_usage/quickstart
|
|
legacy_usage/manual
|
|
legacy_usage/use_cases
|
|
legacy_usage/errors
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Legacy Release Notes:
|
|
|
|
releasenotes/0.0.13-changelog
|
|
releasenotes/0.0.12-changelog
|
|
releasenotes/0.0.11-changelog
|
|
releasenotes/0.0.10-changelog
|
|
releasenotes/0.0.9-changelog
|
|
releasenotes/0.0.8-changelog
|
|
releasenotes/0.0.7-changelog
|
|
releasenotes/0.0.6-changelog
|
|
releasenotes/0.0.5-changelog
|
|
releasenotes/0.0.4-changelog
|
|
releasenotes/0.0.1-changelog
|
|
|
|
.. Indices and tables
|
|
.. ==================
|
|
|
|
.. * :ref:`genindex`
|
|
.. * :ref:`modindex`
|
|
.. * :ref:`search`
|