ytxd

Name	ytxd JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	A user-friendly cli tool for downloading video and audio from url. YTXD is wrapper around the yt-dlp.
upload_time	2024-10-26 18:50:04
maintainer	None
docs_url	None
author	None
requires_python	>=3.12
license	This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, please refer to <https://unlicense.org>
keywords	audio cli downloader video ffmpeg youtube-dl typer uv yt-dlp
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # **Y**ou**T**ube **X** **D**ownload (**_YTXD_**)

An easy to use wrapper around [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) CLI.

_**YTXD**_ is a command line tool that allows You to download from YouTube (or X, etc ...). The main purpose of _**YTXD**_ is to provide easy to use interface for downloading video or audio scores.

## Usage

### direct commands

```bash
# download video to current working directory
$ ytxd video <video-url>

# download audio score of video to current working directory
$ ytxd audio <video-url>

# download video or audio to path with given extansion and filename, path can be relative
$ ytxd video -o Videos/clip.mkv <video-url>

# download best quality avaiable
$ ytxd video --best <video-url>

# specify path, resolution and video format
$ ytxd video --resolution 720p --format flac --path ~/Downloads <video-url>
```

## Installation

**_ytxd_** is avaiable on _PyPI_:

```bash
pip install ytxd
```

Once installed, `ytxd` will be exposed as a command-line tool:

```bash
ytxd --help
```

_**ytxd**_ requires [`ffmpeg`](https://www.ffmpeg.org/) to run. `Ffmpeg` installation site [https://www.ffmpeg.org/download.html](https://www.ffmpeg.org/download.html) and/or commands:

```bash
# ubuntu / debian
$ sudo apt-get update && sudo apt-get install ffmpeg
```

```PowerShell
# windows 10/11
> winget install ffmpeg
```

### Recomendation

I suggest to use **_ytxd_** via [`uv`](https://docs.astral.sh/uv/), an extremely fast Python package and project manager, written in Rust..
After following guide and installing `uv` from [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/), **_ytxd_** can be used by typing command:

```bash
uvx ytxd --help
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ytxd",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "audio, cli, downloader, video, ffmpeg, youtube-dl, typer, uv, yt-dlp",
    "author": null,
    "author_email": "Mateusz Gancarek <mateusz.gancarek@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/32/6b/cca90e9255a94fa3f96821d9623e17a11c82ff917816abfb4e51e4b2ef4f/ytxd-0.0.1.tar.gz",
    "platform": null,
    "description": "# **Y**ou**T**ube **X** **D**ownload (**_YTXD_**)\n\nAn easy to use wrapper around [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) CLI.\n\n_**YTXD**_ is a command line tool that allows You to download from YouTube (or X, etc ...). The main purpose of _**YTXD**_ is to provide easy to use interface for downloading video or audio scores.\n\n## Usage\n\n### direct commands\n\n```bash\n# download video to current working directory\n$ ytxd video <video-url>\n\n# download audio score of video to current working directory\n$ ytxd audio <video-url>\n\n# download video or audio to path with given extansion and filename, path can be relative\n$ ytxd video -o Videos/clip.mkv <video-url>\n\n# download best quality avaiable\n$ ytxd video --best <video-url>\n\n# specify path, resolution and video format\n$ ytxd video --resolution 720p --format flac --path ~/Downloads <video-url>\n```\n\n## Installation\n\n**_ytxd_** is avaiable on _PyPI_:\n\n```bash\npip install ytxd\n```\n\nOnce installed, `ytxd` will be exposed as a command-line tool:\n\n```bash\nytxd --help\n```\n\n_**ytxd**_ requires [`ffmpeg`](https://www.ffmpeg.org/) to run. `Ffmpeg` installation site [https://www.ffmpeg.org/download.html](https://www.ffmpeg.org/download.html) and/or commands:\n\n```bash\n# ubuntu / debian\n$ sudo apt-get update && sudo apt-get install ffmpeg\n```\n\n```PowerShell\n# windows 10/11\n> winget install ffmpeg\n```\n\n### Recomendation\n\nI suggest to use **_ytxd_** via [`uv`](https://docs.astral.sh/uv/), an extremely fast Python package and project manager, written in Rust..\nAfter following guide and installing `uv` from [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/), **_ytxd_** can be used by typing command:\n\n```bash\nuvx ytxd --help\n```\n",
    "bugtrack_url": null,
    "license": "This is free and unencumbered software released into the public domain.  Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.  In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  For more information, please refer to <https://unlicense.org> ",
    "summary": "A user-friendly cli tool for downloading video and audio from url. YTXD is wrapper around the yt-dlp.",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/imoneo/ytxd"
    },
    "split_keywords": [
        "audio",
        " cli",
        " downloader",
        " video",
        " ffmpeg",
        " youtube-dl",
        " typer",
        " uv",
        " yt-dlp"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "06bc72af5e279bc3c5eac784dedc2deec91287c9d99cfbaf627abc6a8d6b8081",
                "md5": "ab9727a940691dc4f22549aad6c1abaf",
                "sha256": "97c8eb4eba8cf91f2e01740755fde453fed40416f7f072558eb3afa88c39109f"
            },
            "downloads": -1,
            "filename": "ytxd-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ab9727a940691dc4f22549aad6c1abaf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 9106,
            "upload_time": "2024-10-26T18:50:03",
            "upload_time_iso_8601": "2024-10-26T18:50:03.117152Z",
            "url": "https://files.pythonhosted.org/packages/06/bc/72af5e279bc3c5eac784dedc2deec91287c9d99cfbaf627abc6a8d6b8081/ytxd-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "326bcca90e9255a94fa3f96821d9623e17a11c82ff917816abfb4e51e4b2ef4f",
                "md5": "e6f9bb3b2f8041408963f7056a9a5c63",
                "sha256": "784413a35e26bb42cadbe817997f84be76b650ba045e7f2169f630129f1aef3c"
            },
            "downloads": -1,
            "filename": "ytxd-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e6f9bb3b2f8041408963f7056a9a5c63",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 10596,
            "upload_time": "2024-10-26T18:50:04",
            "upload_time_iso_8601": "2024-10-26T18:50:04.485637Z",
            "url": "https://files.pythonhosted.org/packages/32/6b/cca90e9255a94fa3f96821d9623e17a11c82ff917816abfb4e51e4b2ef4f/ytxd-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-26 18:50:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "imoneo",
    "github_project": "ytxd",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "ytxd"
}