{ "info": { "author": "airborne007", "author_email": "huangtao0202@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: Implementation :: CPython" ], "description": "# v2sub\n\nA v2ray subscriber written by python3\n\n* [\u4e2d\u6587\u7248\u672c](./README_CN.md)\n\nFeatures:\n\n- multiple subscribes support\n\n- run system `v2ray` which can be controlled by `systemctl` command\n\n- node delay test is support\n\n## Installation\n\nThe easiest way to get `v2sub` is to use `pip`:\n\n```bash\npip install v2sub\n```\n\nTo install latest development version once:\n\n```bash\npip install git+https://github.com/airborne007/v2sub.git@master\n```\n\n## Usage\n\n**NOTE:** Before using, I will assume that you have installed v2ray and v2sub\n\nIf you have only one subscribe source, usage is really simple. Just do as\nfollowing steps:\n\n1. add a subscribe source\n\n ```bash\n v2sub add [url]\n ```\n\n2. update subscribe\n\n ```bash\n v2sub update\n ```\n\n3. run and enjoin it(root or sudo is needed)\n\n ```bash\n v2sub run [index]\n ```\n\n *All nodes will be list after update, the `index` is the order of node.*\n\n## More Details\n\n1. help message\n\n ```bash\n # v2sub --help\n Usage: v2sub [OPTIONS] COMMAND [ARGS]...\n\n A v2ray subscriber written by python3\n\n Options:\n --help Show this message and exit.\n\n Commands:\n add add a subscribe.\n list list subscribe nodes.\n ping test node delay by ping.\n remove remove subscribe.\n run start v2ray with an specify node.\n update update subscribe nodes.\n version show version\n ```\n\n2. add or update subscribe\n\n ```bash\n # v2sub add --help\n Usage: v2sub add [OPTIONS] URL\n\n add a subscribe.\n\n URL: url of the subscribe\n\n Options:\n --name TEXT name of the subscribe, if not provided, a default name will be\n given.\n --help Show this message and exit.\n ```\n\n3. update subscribe nodes\n\n ```bash\n # v2sub update --help\n Usage: v2sub update [OPTIONS]\n\n update subscribe nodes.\n\n Options:\n --name TEXT the name of the subscribe you want to update, if not\n provided, default subscribe will be updated.\n --all-subs, --all whether to update all subscribe, default is False.\n --help Show this message and exit.\n ```\n\n4. list subscribe nodes\n\n ```bash\n # v2sub list --help\n Usage: v2sub list [OPTIONS]\n\n list subscribe nodes.\n\n Options:\n --name TEXT the name of the subscribe you want list, if not provided,\n default subscribe will be listed.\n --all-subs, --all whether list all subscribe, default is False.\n --help Show this message and exit.\n ```\n\n5. remove subscribe and it's nodes\n\n ```bash\n # v2sub remove --help\n Usage: v2sub remove [OPTIONS]\n\n remove subscribe and it\\'s nodes.\n\n Options:\n --name TEXT name of subscribe will be removed, if not provided,\n default subscribe will be removed.\n --all-subs, --all whether remove all subscribe, default is False.\n --help Show this message and exit.\n ```\n\n6. run or switch node\n\n ```bash\n # v2sub run --help\n Usage: v2sub run [OPTIONS] INDEX\n\n start v2ray with an specify node.\n\n INDEX: the index node id list before.\n\n Options:\n --name TEXT the name of the subscribe you want run with. if not\n provided, the default subscribe will be run.\n --port INTEGER the local port v2ray client listen on, default is 1080\n --help Show this message and exit.\n ```\n\n7. test node delay\n\n ```bash\n Usage: v2sub ping [OPTIONS]\n\n Options:\n --name TEXT the name of the subscribe you want ping with. if not\n provided, default subscribe will be pinged.\n --index INTEGER the node of subscribe you want to ping with. if not\n provided, will test all node delay.\n --help Show this message and exit.\n ```\n\n## TODO\n\nsupport more features.\n\n## More\n\nThis program can run on all Linux platforms in theory, but I only tested it on\n`Arch Linux`. If you have any problems with other linux distributions, issue or\npull request is welcome.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/airborne007/v2sub", "keywords": "v2ray,subscriber,linux", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "v2sub", "package_url": "https://pypi.org/project/v2sub/", "platform": "", "project_url": "https://pypi.org/project/v2sub/", "project_urls": { "Homepage": "https://github.com/airborne007/v2sub", "Tracker": "https://github.com/airborne007/v2sub/issues" }, "release_url": "https://pypi.org/project/v2sub/1.0/", "requires_dist": null, "requires_python": ">=3", "summary": "A v2ray subscriber written by python3", "version": "1.0" }, "last_serial": 5770919, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "b78cd200445c37f4c6e0761557add008", "sha256": "b27c5a629942d10199e29c5a21830acab169e3fe8dc5f8e343ca9bf2f462a18f" }, "downloads": -1, "filename": "v2sub-0.1.tar.gz", "has_sig": false, "md5_digest": "b78cd200445c37f4c6e0761557add008", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 6450, "upload_time": "2019-08-06T13:31:06", "url": "https://files.pythonhosted.org/packages/d9/4a/21ebac8f2750413934451f37e540cfcfe5347e90e2a701fa213aabd0d5fa/v2sub-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "52384fc1e34dc80f517c786f5d11269f", "sha256": "558d335efde1ece7c5e16f8f002c9603c7591ae6e990ffc8f1a04494c8125fdf" }, "downloads": -1, "filename": "v2sub-0.2.tar.gz", "has_sig": false, "md5_digest": "52384fc1e34dc80f517c786f5d11269f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 6611, "upload_time": "2019-08-06T15:23:06", "url": "https://files.pythonhosted.org/packages/8f/1a/09275cd3aaeb74e9438f6c08a21f856cfd8e8f969e383fb207c89859bfe5/v2sub-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "f5a3735d7e89fa340917fdae21bb4934", "sha256": "ec3f2b774ce7c3cfcc01006ea4ef88eaa0f69c3a12c9816ae6f7be58597fa6f1" }, "downloads": -1, "filename": "v2sub-0.3.tar.gz", "has_sig": false, "md5_digest": "f5a3735d7e89fa340917fdae21bb4934", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 6661, "upload_time": "2019-08-13T13:25:17", "url": "https://files.pythonhosted.org/packages/73/b3/ef7819bec040267d8f91d54ac67fa9561fcc3eca8bee5e9ef5caacaac921/v2sub-0.3.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "27e3004abd8fae5b537581bac07fa20b", "sha256": "7f1bcf12070ae1f82136a5f1dcc86e6e80c5992ffd475603540a23d187e6d582" }, "downloads": -1, "filename": "v2sub-1.0.tar.gz", "has_sig": false, "md5_digest": "27e3004abd8fae5b537581bac07fa20b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 6743, "upload_time": "2019-09-02T13:42:30", "url": "https://files.pythonhosted.org/packages/5f/9e/98af8c374bb1a9f20a622558f14382d4726ac65b0256dc014827cd310265/v2sub-1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "27e3004abd8fae5b537581bac07fa20b", "sha256": "7f1bcf12070ae1f82136a5f1dcc86e6e80c5992ffd475603540a23d187e6d582" }, "downloads": -1, "filename": "v2sub-1.0.tar.gz", "has_sig": false, "md5_digest": "27e3004abd8fae5b537581bac07fa20b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 6743, "upload_time": "2019-09-02T13:42:30", "url": "https://files.pythonhosted.org/packages/5f/9e/98af8c374bb1a9f20a622558f14382d4726ac65b0256dc014827cd310265/v2sub-1.0.tar.gz" } ] }