{ "info": { "author": "bluecap-se", "author_email": "hello@bluecap.se", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Flask", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: MacOS", "Operating System :: POSIX", "Programming Language :: Python :: 2 :: Only", "Topic :: Internet :: WWW/HTTP :: Indexing/Search" ], "description": "Yarr! client\r\n============\r\n\r\n|Circle CI| |Dependency Status| |PyPI version| |Docker pulls|\r\n\r\nWeb client for `Yarr!`_ in Python.\r\n\r\nInstall\r\n-------\r\n\r\nUsing Docker\r\n~~~~~~~~~~~~\r\n\r\n.. code:: console\r\n\r\n $ docker run -d -p 80:5000 bluecap/yarr.client:latest\r\n\r\nUsing a package manager\r\n~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\n.. code:: console\r\n\r\n $ pip install yarr.client\r\n\r\nFrom source\r\n~~~~~~~~~~~\r\n\r\n.. code:: console\r\n\r\n $ git clone https://github.com/bluecap-se/yarr.client.git\r\n $ cd yarr.client\r\n $ pip install -r requirements.txt\r\n $ pip install -e .\r\n\r\nUsage\r\n-----\r\n\r\nQuickstart\r\n~~~~~~~~~~\r\n\r\n.. code:: console\r\n\r\n $ yarr.client\r\n\r\n * Running on http://0.0.0.0:5000/\r\n * Restarting with reloader\r\n\r\nOptions\r\n~~~~~~~\r\n\r\nThe configuration file params are defined in the `Flask documentation`_.\r\n\r\nAdditional, app-specific params are ``YARR_URL`` and ``YARR_API_TOKEN``.\r\n``YARR_URL`` is the path to the `Yarr!`_ server, and ``YARR_API_TOKEN``\r\nneeds to be set if the server has a corresponding token specified in its\r\nconfig.\r\n\r\n.. code:: console\r\n\r\n $ yarr.client -h\r\n\r\n Yarr.client - Web Client for Yarr!\r\n\r\n Usage:\r\n yarr.client runserver [--config FILE] [options]\r\n\r\n Options:\r\n -c, --config FILE Path to Flask config file (params: bit.ly/1uamUo1)\r\n -h, --help Output this help and exit\r\n -v, --version Output version and exit\r\n\r\n Examples:\r\n yarr.client runserver\r\n yarr.client runserver -c /etc/production.cfg\r\n\r\nOptions with Docker\r\n^^^^^^^^^^^^^^^^^^^\r\n\r\nTo use a custom configuration file in Docker, map your file using\r\nvolumes.\r\n\r\n.. code:: console\r\n\r\n $ docker run -d -p 80:5000 -v /path/to/your/config.cfg:/yarr.config.cfg bluecap/yarr.client:latest\r\n\r\nRun tests\r\n---------\r\n\r\n.. code:: console\r\n\r\n $ pip install -r test_requirements.txt\r\n $ py.test\r\n\r\nWatch for changes\r\n~~~~~~~~~~~~~~~~~\r\n\r\nTo run the tests continuously, run the test command with the watch or\r\nfollow flag ``-f``:\r\n\r\n.. code:: console\r\n\r\n $ py.test -f\r\n\r\nTest coverage\r\n~~~~~~~~~~~~~\r\n\r\n.. code:: console\r\n\r\n $ coverage run --source yarr_client -m py.test\r\n $ coverage html\r\n $ open htmlcov/index.html\r\n\r\nLicense\r\n-------\r\n\r\nPublished under `MIT License`_.\r\n\r\n.. _Yarr!: https://github.com/bluecap-se/yarr\r\n.. _Flask documentation: http://flask.pocoo.org/docs/0.10/config/#builtin-configuration-values\r\n.. _MIT License: https://github.com/bluecap-se/yarr.client/blob/master/LICENSE\r\n\r\n.. |Circle CI| image:: https://img.shields.io/circleci/project/bluecap-se/yarr.client.svg?style=flat-square\r\n :target: https://circleci.com/gh/bluecap-se/yarr.client\r\n.. |Dependency Status| image:: https://img.shields.io/gemnasium/bluecap-se/yarr.client.svg?style=flat-square\r\n :target: https://gemnasium.com/bluecap-se/yarr.client\r\n.. |PyPI version| image:: https://img.shields.io/pypi/v/yarr.client.svg?style=flat-square\r\n :target: https://pypi.python.org/pypi/yarr.client/\r\n.. |Docker pulls| image:: https://img.shields.io/docker/pulls/bluecap/yarr.client.svg?style=flat-square\r\n :target: https://registry.hub.docker.com/u/bluecap/yarr.client/", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bluecap-se/yarr.client", "keywords": "yarr,the pirate bay,web based,client", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "yarr.client", "package_url": "https://pypi.org/project/yarr.client/", "platform": "any", "project_url": "https://pypi.org/project/yarr.client/", "project_urls": { "Homepage": "https://github.com/bluecap-se/yarr.client" }, "release_url": "https://pypi.org/project/yarr.client/0.2.1/", "requires_dist": null, "requires_python": null, "summary": "Web-based client for Yarr!", "version": "0.2.1" }, "last_serial": 1718790, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "88358f2e838e1c4d3ae030b654351cd1", "sha256": "d94a31f4363254047377fd2bdf40080f50104df32c7e701192bb74a5d6618f33" }, "downloads": -1, "filename": "yarr.client-0.1.0.tar.gz", "has_sig": false, "md5_digest": "88358f2e838e1c4d3ae030b654351cd1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12404, "upload_time": "2014-11-20T10:21:29", "url": "https://files.pythonhosted.org/packages/95/ea/e1a7c23fdcb05f5647c40f0b81282e335be3141fa2937e830c9d294ea1ff/yarr.client-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "950babe370b816e767a3d4dce9420a41", "sha256": "c410b28ddc97b71e32664eb4ca4e7b068b559c8b6db52aae5d011a3979fbb762" }, "downloads": -1, "filename": "yarr.client--0.2.0.tar.gz", "has_sig": false, "md5_digest": "950babe370b816e767a3d4dce9420a41", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12651, "upload_time": "2015-09-11T11:45:59", "url": "https://files.pythonhosted.org/packages/61/67/136e194ef4bfa0bce7e32aae42fca44966d8b56b32d61c53cc959f778bb4/yarr.client--0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "6a81950fe742f7037b5581308fd20ae5", "sha256": "6df3731d71f52e783b60cfe2a5063f32fe6eb58c0600ba3725458802faae5a36" }, "downloads": -1, "filename": "yarr.client-0.2.1.tar.gz", "has_sig": false, "md5_digest": "6a81950fe742f7037b5581308fd20ae5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12652, "upload_time": "2015-09-11T12:01:28", "url": "https://files.pythonhosted.org/packages/3f/a3/ac0e46b35dd532572b84db341f439ea496e23c2034f799f46545249d4aef/yarr.client-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6a81950fe742f7037b5581308fd20ae5", "sha256": "6df3731d71f52e783b60cfe2a5063f32fe6eb58c0600ba3725458802faae5a36" }, "downloads": -1, "filename": "yarr.client-0.2.1.tar.gz", "has_sig": false, "md5_digest": "6a81950fe742f7037b5581308fd20ae5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12652, "upload_time": "2015-09-11T12:01:28", "url": "https://files.pythonhosted.org/packages/3f/a3/ac0e46b35dd532572b84db341f439ea496e23c2034f799f46545249d4aef/yarr.client-0.2.1.tar.gz" } ] }