BAET


NameBAET JSON
Version 1.0.1 PyPI version JSON
download
home_page
SummaryA tool to bulk extract audio tracks from video using FFmpeg
upload_time2024-03-04 12:47:13
maintainerTimeTravelPenguin
docs_urlNone
authorPhillip Smith
requires_python>=3.11,<4.0.0
licenseGPL-3.0-or-later
keywords ffmpeg audio video extract bulk batch
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="./images/logo.png" alt="Logo" style="display: block; max-width: 50%; margin: auto">

<h2 align="center">
    A commandline tool to bulk export audio tracks.
</h2>

<!-- TODO: https://shields.io/badges -->

<p align="center">
    <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/baet">
    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/baet">
    <img alt="PyPI - Implementation" src="https://img.shields.io/pypi/implementation/baet">
    <img alt="Python Version from PEP 621 TOML" src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FTimeTravelPenguin%2FBulkAudioExtractTool%2Fmain%2Fpyproject.toml">
</p>

<p align="center">
    <img alt="GitHub License" src="https://img.shields.io/github/license/TimeTravelPenguin/BulkAudioExtractTool">
    <img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/TimeTravelPenguin/BulkAudioExtractTool/CI.yml">
    <img alt="GitHub last commit (by committer)" src="https://img.shields.io/github/last-commit/TimeTravelPenguin/BulkAudioExtractTool">
</p>

## Install

### Requirements

BAET will run on Windows, macOS, and Linux. Listed below the pre-installation requirements:

- FFmpeg ([website](https://ffmpeg.org))
- Python v3.12+ ([website](https://www.python.org))

### Installing BAET

Installation is done via `pip`.
Depending on your platform, to call python, you may need to use the command `python` or `python3`.
Typing `python3 --version` or `python --version` should display the currently installed python environment your PATH.
For the remainder of this document, replace instances of `python` with the appropriate alias on your machine.

To install the most recent stable release, use:

```bash
python -m pip install baet
```

For pre-releases, use:

```bash
python -m pip install baet --pre
```

To update/upgrade to a new version, use:

```bash
python -m pip install baet -U [--pre]
```

To verify your install, call

```bash
baet --version
```

## Usage

Once installed, calling `baet --help` will display the general help screen, showing a list of options you can use.

<img src="./docs/img/baet_help.svg" alt="baet help screen" style="display: block; margin: auto; max-height: 500px">

<img src="./docs/img/baet_extract_help.svg" alt="baet help screen" style="display: block; margin: auto; max-height: 500px">

<img src="./docs/img/baet_probe_help.svg" alt="baet help screen" style="display: block; margin: auto; max-height: 500px">

To simply extract the audio tracks of all videos in a directory `~/inputs`,
and extract each into a subdirectory of `~/outputs`, call

```bash
baet -i "~/inputs" -o "~/outputs"
```

Unless you add the option `--no-subdirs`, a video `~/inputs/my_video.mp4` will have each audio track individually
exported to an audio file located in `~/outputs/my_video/`.

### Note on the help screen

Currently, the help screen contains descriptions starting with `[TODO]`.
This indicates that the associated option may or may not be implemented fully or at all.

## Known issues

- The option `--no-subdirs` may cause BAET to misbehave if two files are generated with the same name,
  unless the option `--overwrite` is given, in which case one file will be overwritten.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "BAET",
    "maintainer": "TimeTravelPenguin",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0.0",
    "maintainer_email": "TimeTravelPenguin@gmail.com",
    "keywords": "ffmpeg,audio,video,extract,bulk,batch",
    "author": "Phillip Smith",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c3/1f/1963ce269f071c70a4e5425f82a4952df376728751fb4c854be5a1bf9649/baet-1.0.1.tar.gz",
    "platform": null,
    "description": "<img src=\"./images/logo.png\" alt=\"Logo\" style=\"display: block; max-width: 50%; margin: auto\">\n\n<h2 align=\"center\">\n    A commandline tool to bulk export audio tracks.\n</h2>\n\n<!-- TODO: https://shields.io/badges -->\n\n<p align=\"center\">\n    <img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/baet\">\n    <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/baet\">\n    <img alt=\"PyPI - Implementation\" src=\"https://img.shields.io/pypi/implementation/baet\">\n    <img alt=\"Python Version from PEP 621 TOML\" src=\"https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2FTimeTravelPenguin%2FBulkAudioExtractTool%2Fmain%2Fpyproject.toml\">\n</p>\n\n<p align=\"center\">\n    <img alt=\"GitHub License\" src=\"https://img.shields.io/github/license/TimeTravelPenguin/BulkAudioExtractTool\">\n    <img alt=\"GitHub Actions Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/TimeTravelPenguin/BulkAudioExtractTool/CI.yml\">\n    <img alt=\"GitHub last commit (by committer)\" src=\"https://img.shields.io/github/last-commit/TimeTravelPenguin/BulkAudioExtractTool\">\n</p>\n\n## Install\n\n### Requirements\n\nBAET will run on Windows, macOS, and Linux. Listed below the pre-installation requirements:\n\n- FFmpeg ([website](https://ffmpeg.org))\n- Python v3.12+ ([website](https://www.python.org))\n\n### Installing BAET\n\nInstallation is done via `pip`.\nDepending on your platform, to call python, you may need to use the command `python` or `python3`.\nTyping `python3 --version` or `python --version` should display the currently installed python environment your PATH.\nFor the remainder of this document, replace instances of `python` with the appropriate alias on your machine.\n\nTo install the most recent stable release, use:\n\n```bash\npython -m pip install baet\n```\n\nFor pre-releases, use:\n\n```bash\npython -m pip install baet --pre\n```\n\nTo update/upgrade to a new version, use:\n\n```bash\npython -m pip install baet -U [--pre]\n```\n\nTo verify your install, call\n\n```bash\nbaet --version\n```\n\n## Usage\n\nOnce installed, calling `baet --help` will display the general help screen, showing a list of options you can use.\n\n<img src=\"./docs/img/baet_help.svg\" alt=\"baet help screen\" style=\"display: block; margin: auto; max-height: 500px\">\n\n<img src=\"./docs/img/baet_extract_help.svg\" alt=\"baet help screen\" style=\"display: block; margin: auto; max-height: 500px\">\n\n<img src=\"./docs/img/baet_probe_help.svg\" alt=\"baet help screen\" style=\"display: block; margin: auto; max-height: 500px\">\n\nTo simply extract the audio tracks of all videos in a directory `~/inputs`,\nand extract each into a subdirectory of `~/outputs`, call\n\n```bash\nbaet -i \"~/inputs\" -o \"~/outputs\"\n```\n\nUnless you add the option `--no-subdirs`, a video `~/inputs/my_video.mp4` will have each audio track individually\nexported to an audio file located in `~/outputs/my_video/`.\n\n### Note on the help screen\n\nCurrently, the help screen contains descriptions starting with `[TODO]`.\nThis indicates that the associated option may or may not be implemented fully or at all.\n\n## Known issues\n\n- The option `--no-subdirs` may cause BAET to misbehave if two files are generated with the same name,\n  unless the option `--overwrite` is given, in which case one file will be overwritten.\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "A tool to bulk extract audio tracks from video using FFmpeg",
    "version": "1.0.1",
    "project_urls": {
        "homepage": "https://github.com/TimeTravelPenguin/BulkAudioExtractTool",
        "repository": "https://github.com/TimeTravelPenguin/BulkAudioExtractTool"
    },
    "split_keywords": [
        "ffmpeg",
        "audio",
        "video",
        "extract",
        "bulk",
        "batch"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cf058583eb1fca818d45080806a2728fff40b0d10aea0e76fe6f45f01613389a",
                "md5": "4375d9b7087500b1d27c56d26c4ca7a0",
                "sha256": "ff7c99870b280fb5ab10f62176f23ef5fd2209b7257d43b26e1a15f6a00c5afe"
            },
            "downloads": -1,
            "filename": "baet-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4375d9b7087500b1d27c56d26c4ca7a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0.0",
            "size": 35305,
            "upload_time": "2024-03-04T12:47:11",
            "upload_time_iso_8601": "2024-03-04T12:47:11.969883Z",
            "url": "https://files.pythonhosted.org/packages/cf/05/8583eb1fca818d45080806a2728fff40b0d10aea0e76fe6f45f01613389a/baet-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c31f1963ce269f071c70a4e5425f82a4952df376728751fb4c854be5a1bf9649",
                "md5": "f39f2f8fcf1f692ce218154d9f5b8dd9",
                "sha256": "0ccd778a6989a96b3637a599e32191d33a8c100ab87e954725972d225ab9da20"
            },
            "downloads": -1,
            "filename": "baet-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f39f2f8fcf1f692ce218154d9f5b8dd9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0.0",
            "size": 30185,
            "upload_time": "2024-03-04T12:47:13",
            "upload_time_iso_8601": "2024-03-04T12:47:13.861234Z",
            "url": "https://files.pythonhosted.org/packages/c3/1f/1963ce269f071c70a4e5425f82a4952df376728751fb4c854be5a1bf9649/baet-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-04 12:47:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TimeTravelPenguin",
    "github_project": "BulkAudioExtractTool",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "baet"
}
        
Elapsed time: 0.19485s