fs.youtube


Namefs.youtube JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/media-proxy/fs.youtube
SummaryYoutube Filesystem for PyFilsystem2
upload_time2019-10-15 11:42:18
maintainer
docs_urlNone
authorMerlin Kessler
requires_python!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7
licenseMIT
keywords filesystem pyfilesystem2 pafy youtube
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            fs.youtube
==========

.. image:: https://badge.fury.io/py/fs.youtube.svg
    :target: https://badge.fury.io/py/fs.youtube

.. image:: https://travis-ci.org/media-proxy/fs.youtube.svg?branch=master
    :target: https://travis-ci.org/media-proxy/fs.youtube

.. image:: https://api.codacy.com/project/badge/Grade/c8331c97a4054df88cc79878c615cdb2
    :target: https://www.codacy.com/app/media-proxy/fs.youtube?utm_source=github.com&utm_medium=referral&utm_content=media-proxy/fs.youtube&utm_campaign=Badge_Grade

.. image:: https://codecov.io/gh/media-proxy/fs.youtube/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/media-proxy/fs.youtube

.. image:: https://pyup.io/repos/github/media-proxy/fs.youtube/shield.svg
    :target: https://pyup.io/repos/github/media-proxy/fs.youtube/

A PyFilesystem2 implementation for accessing YouTube Videos and
Playlists

Installation
------------

Install directly from PyPI, using `pip <https://pip.pypa.io/>`__:

::

    pip install fs.youtube

Usage
-----

Opener
~~~~~~

Use ``fs.open_fs`` to open a filesystem with an Youtube `FS
URL <https://pyfilesystem2.readthedocs.io/en/latest/openers.html>`__:

.. code:: python

    import fs
    yt_fs = fs.open_fs('youtube://youtubeplaylistid')

The opener can use either use the YouTube Playlist ID or the whole
Youtube URL.

Also Single Youtube Videos are supported.

Constructor
~~~~~~~~~~~

.. code:: python

    import fs.youtube
    yt_fs = fs.youtube.YoutubeFS(
            url, playlist=True, seekable=True
            )

with each argument explained below:

``url`` The Playlist/Video URL or simly use the YouTube ID

``playlist`` If the ID or URL is one Video only, set this to False

``seekable`` Use a seekable implementation to move inside the videofile.

Once created, the ``YoutubeFS`` filesystem behaves like any other
filesystem (see the `Pyfilesystem2
documentation <https://pyfilesystem2.readthedocs.io>`__).

Feedback
--------

Found a bug ? Have an enhancement request ? Head over to the `GitHub
issue tracker <https://github.com/media-proxy/fs.youtube/issues>`__ of
the project if you need to report or ask something. If you are filling
in on a bug, please include as much information as you can about the
issue, and try to recreate the same bug in a simple, easily
reproductible situation.

See also
--------

-  `fs <https://github.com/Pyfilesystem/pyfilesystem2>`__, the core
   Pyfilesystem2 library
-  `Index of
   Filesystems <https://www.pyfilesystem.org/page/index-of-filesystems/>`__,
   a list of PyFilesystem 2 implementations

.. |PyPI version| image:: https://badge.fury.io/py/fs.youtube.svg
   :target: https://pypi.python.org/pypi/fs.youtube
.. |Build Status| image:: https://travis-ci.org/media-proxy/fs.youtube.svg?branch=master
   :target: https://travis-ci.org/media-proxy/fs.youtube
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/c8331c97a4054df88cc79878c615cdb2
   :target: https://www.codacy.com/app/media-proxy/fs.youtube?utm_source=github.com&utm_medium=referral&utm_content=media-proxy/fs.youtube&utm_campaign=Badge_Grade
.. |codecov| image:: https://codecov.io/gh/media-proxy/fs.youtube/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/media-proxy/fs.youtube



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/media-proxy/fs.youtube",
    "name": "fs.youtube",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
    "maintainer_email": "",
    "keywords": "filesystem,Pyfilesystem2,pafy,youtube",
    "author": "Merlin Kessler",
    "author_email": "m3rlink@gmx.de",
    "download_url": "https://files.pythonhosted.org/packages/f0/70/44f99810012e9ae433fa84148c6ab087a837bb9d93153f337cf47eab6bd3/fs.youtube-0.3.1.tar.gz",
    "platform": "any",
    "description": "fs.youtube\n==========\n\n.. image:: https://badge.fury.io/py/fs.youtube.svg\n    :target: https://badge.fury.io/py/fs.youtube\n\n.. image:: https://travis-ci.org/media-proxy/fs.youtube.svg?branch=master\n    :target: https://travis-ci.org/media-proxy/fs.youtube\n\n.. image:: https://api.codacy.com/project/badge/Grade/c8331c97a4054df88cc79878c615cdb2\n    :target: https://www.codacy.com/app/media-proxy/fs.youtube?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=media-proxy/fs.youtube&amp;utm_campaign=Badge_Grade\n\n.. image:: https://codecov.io/gh/media-proxy/fs.youtube/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/media-proxy/fs.youtube\n\n.. image:: https://pyup.io/repos/github/media-proxy/fs.youtube/shield.svg\n    :target: https://pyup.io/repos/github/media-proxy/fs.youtube/\n\nA PyFilesystem2 implementation for accessing YouTube Videos and\nPlaylists\n\nInstallation\n------------\n\nInstall directly from PyPI, using `pip <https://pip.pypa.io/>`__:\n\n::\n\n    pip install fs.youtube\n\nUsage\n-----\n\nOpener\n~~~~~~\n\nUse ``fs.open_fs`` to open a filesystem with an Youtube `FS\nURL <https://pyfilesystem2.readthedocs.io/en/latest/openers.html>`__:\n\n.. code:: python\n\n    import fs\n    yt_fs = fs.open_fs('youtube://youtubeplaylistid')\n\nThe opener can use either use the YouTube Playlist ID or the whole\nYoutube URL.\n\nAlso Single Youtube Videos are supported.\n\nConstructor\n~~~~~~~~~~~\n\n.. code:: python\n\n    import fs.youtube\n    yt_fs = fs.youtube.YoutubeFS(\n            url, playlist=True, seekable=True\n            )\n\nwith each argument explained below:\n\n``url`` The Playlist/Video URL or simly use the YouTube ID\n\n``playlist`` If the ID or URL is one Video only, set this to False\n\n``seekable`` Use a seekable implementation to move inside the videofile.\n\nOnce created, the ``YoutubeFS`` filesystem behaves like any other\nfilesystem (see the `Pyfilesystem2\ndocumentation <https://pyfilesystem2.readthedocs.io>`__).\n\nFeedback\n--------\n\nFound a bug ? Have an enhancement request ? Head over to the `GitHub\nissue tracker <https://github.com/media-proxy/fs.youtube/issues>`__ of\nthe project if you need to report or ask something. If you are filling\nin on a bug, please include as much information as you can about the\nissue, and try to recreate the same bug in a simple, easily\nreproductible situation.\n\nSee also\n--------\n\n-  `fs <https://github.com/Pyfilesystem/pyfilesystem2>`__, the core\n   Pyfilesystem2 library\n-  `Index of\n   Filesystems <https://www.pyfilesystem.org/page/index-of-filesystems/>`__,\n   a list of PyFilesystem 2 implementations\n\n.. |PyPI version| image:: https://badge.fury.io/py/fs.youtube.svg\n   :target: https://pypi.python.org/pypi/fs.youtube\n.. |Build Status| image:: https://travis-ci.org/media-proxy/fs.youtube.svg?branch=master\n   :target: https://travis-ci.org/media-proxy/fs.youtube\n.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/c8331c97a4054df88cc79878c615cdb2\n   :target: https://www.codacy.com/app/media-proxy/fs.youtube?utm_source=github.com&utm_medium=referral&utm_content=media-proxy/fs.youtube&utm_campaign=Badge_Grade\n.. |codecov| image:: https://codecov.io/gh/media-proxy/fs.youtube/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/media-proxy/fs.youtube\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Youtube Filesystem for PyFilsystem2",
    "version": "0.3.1",
    "split_keywords": [
        "filesystem",
        "pyfilesystem2",
        "pafy",
        "youtube"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0e1cfec9cd6c5b2c9e3c982bcd29cc66",
                "sha256": "64c2719851b122e66fca97177ee283fb6499b5354776d9b77f5e9971db7854aa"
            },
            "downloads": -1,
            "filename": "fs.youtube-0.3.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e1cfec9cd6c5b2c9e3c982bcd29cc66",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
            "size": 7284,
            "upload_time": "2019-10-15T11:42:15",
            "upload_time_iso_8601": "2019-10-15T11:42:15.903732Z",
            "url": "https://files.pythonhosted.org/packages/5d/70/bab7424f71000744d07d5133136adbcb843a4e675d1d719fdfacd1f41d12/fs.youtube-0.3.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "6f1fa9f4dc2463477d8ad77ef27ecbd8",
                "sha256": "63160485055520fa59550ad200852d8ac4d492292a672788088728fab4d003a7"
            },
            "downloads": -1,
            "filename": "fs.youtube-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6f1fa9f4dc2463477d8ad77ef27ecbd8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
            "size": 6609,
            "upload_time": "2019-10-15T11:42:18",
            "upload_time_iso_8601": "2019-10-15T11:42:18.105597Z",
            "url": "https://files.pythonhosted.org/packages/f0/70/44f99810012e9ae433fa84148c6ab087a837bb9d93153f337cf47eab6bd3/fs.youtube-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2019-10-15 11:42:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "media-proxy",
    "github_project": "fs.youtube",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "appveyor": true,
    "lcname": "fs.youtube"
}
        
Elapsed time: 0.01617s