{ "info": { "author": "Joseph Weston", "author_email": "joseph@weston.cloud", "bugtrack_url": null, "classifiers": [], "description": "Nord: an unofficial NordVPN client\n==================================\n\n.. badges-start\n\n.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg\n :target: https://img.shields.io/badge/License-GPL%20v3-blue.svg\n :alt: GPLv3 License\n\n.. image:: https://badge.fury.io/py/nord.svg\n :target: https://badge.fury.io/py/nord\n :alt: PyPi package\n\n.. image:: https://readthedocs.org/projects/nord/badge/?version=stable\n :target: http://nord.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. badges-end\n.. doc-start\n\nOverview\n--------\n\n.. overview\n\nNord is a client for interacting with the `NordVPN`_ service.\n\nAt its core is a high-level Python API for interacting both with the web service\nprovided by NordVPN, and for connecting to VPN servers using OpenVPN.\n\nNord also contains components that expose this API as a command line tool,\nand (soon) as a web service and frontend.\n\n.. _NordVPN: https://nordvpn.com\n\n.. overview-end\n\nLicence\n-------\nNord is licensed under the terms of the GNU GPLv3.\nSee the LICENSE_ file for details.\n\n.. _LICENSE: LICENSE\n\nInstallation\n------------\n::\n\n pip install nord\n\nUsage\n-----\n\nRun ``nord --help`` for the full usage instructions.\n\nConnect to a specific NordVPN server::\n\n nord connect -u my_user -p my_password us893\n\nConnect to any NordVPN server in a given country::\n\n nord connect -u my_user -p my_password US\n\nYou can also supply your password from a file using the ``-f`` flag.\nThe special value ``-`` means \"read from stdin\". This is particularly\nuseful when your password is stored in a utility such as\npass_::\n\n pass nordvpn_password | nord connect -u my_user -f - us893\n\n.. _pass: https://www.passwordstore.org/\n\nPrerequesites\n-------------\n- GNU/Linux system\n- Python 3.6\n- ``openvpn``\n- ``sudo``\n\nnord contains many Linux-isms (e.g. using the ``sudo`` program to obtain root\naccess) so it will certainly not work on Windows, it may possibly work\non OSX and \\*BSD, but support for these platforms is not a goal.\n\nMost recent versions of popular GNU/Linux distributions (with the\nexception of Debian) have both an OpenVPN client and Python 3.6\nin their official repositories. Debian users will have to take\n`additional steps`_ to get a Python 3.6 installation.\n\n.. _additional steps: Debian_\n\n\nUbuntu 16.10 and newer\n**********************\nUbuntu comes with ``sudo`` already installed, so we just need\nto install Python and openVPN::\n\n sudo apt-get install python3.6 openvpn\n\nFedora 26 and newer\n*******************\nFedora comes with ``sudo`` already installed, so we just need\nto install Python and openVPN::\n\n sudo dnf install python36 openvpn\n\nArch Linux\n**********\nRun the following as root::\n\n pacman -S sudo python openvpn\n\nThen configure ``sudo`` by following the `Arch wiki`_\nto give privileges to the user that nord will be running as.\n\n.. _Arch wiki: https://wiki.archlinux.org/index.php/sudo\n\nDebian\n******\nFirst run the following as root to install the openVPN client and\n``sudo`` from the Debian repositories::\n\n apt install sudo openvpn\n\nThen configure ``sudo`` by following the `Debian wiki`_\nto give privileges to the user that nord will be running as.\n\nThere are a couple of options for installing Python3.6 on Debian:\n\n- Installing from the ``unstable`` repositories\n- Installing from source (easier than you might think\n\nBoth of these methods are explained in top-rated answers to this\n`stackexchange question`_.\n\n.. _Debian wiki: https://wiki.debian.org/sudo\n.. _stackexchange question: https://unix.stackexchange.com/questions/332641/how-to-install-python-3-6\n\nDeveloping\n----------\n::\n\n git clone https://github.com/jbweston/nord\n cd nord\n virtualenv -p python3.6\n source venv/bin/activate\n pip install -e .[dev]\n\nBuilding the API documentation\n******************************\n::\n\n make -C docs html\n xdg-open docs/build/html/index.html", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jbweston/nord", "keywords": "", "license": "GNU General Public License v3", "maintainer": "", "maintainer_email": "", "name": "nord", "package_url": "https://pypi.org/project/nord/", "platform": "GNU/Linux", "project_url": "https://pypi.org/project/nord/", "project_urls": { "Homepage": "https://github.com/jbweston/nord" }, "release_url": "https://pypi.org/project/nord/0.2.0/", "requires_dist": null, "requires_python": "", "summary": "Unofficial NordVPN client", "version": "0.2.0" }, "last_serial": 3546377, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "03d1b591f94d28a8766ee35761ee2378", "sha256": "d74821c83d328179c803f603a30d0570735e0d6a7df498f1ae40899fecc498db" }, "downloads": -1, "filename": "nord-0.1.0.tar.gz", "has_sig": false, "md5_digest": "03d1b591f94d28a8766ee35761ee2378", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41360, "upload_time": "2017-09-09T18:52:02", "url": "https://files.pythonhosted.org/packages/f7/17/5eb864b0885515e45858e6c745172811ac4b99fcf4a2583446a589220ad4/nord-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "2173e370c5cb47087e878ebe3130f5a7", "sha256": "79d5782495ff8d113181fa8923e160afaefae088c598a5cc13b996cd4aefc521" }, "downloads": -1, "filename": "nord-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2173e370c5cb47087e878ebe3130f5a7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 19677, "upload_time": "2018-02-02T17:34:38", "url": "https://files.pythonhosted.org/packages/89/6b/32deedaccc0f2cea5b05349234f87a5fd571124f499b0a53700024d474f3/nord-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1fefab3733c07048eb96cd95cf152619", "sha256": "363db13498f8c6c82fda4fecfb7e97bc696d43675528901319161aaf97e40cd9" }, "downloads": -1, "filename": "nord-0.2.0.tar.gz", "has_sig": false, "md5_digest": "1fefab3733c07048eb96cd95cf152619", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 44833, "upload_time": "2018-02-01T14:07:37", "url": "https://files.pythonhosted.org/packages/15/11/5fdff9bde723db4477ab0023f4141a618300d3e9488f60c8bbc49914d42a/nord-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2173e370c5cb47087e878ebe3130f5a7", "sha256": "79d5782495ff8d113181fa8923e160afaefae088c598a5cc13b996cd4aefc521" }, "downloads": -1, "filename": "nord-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "2173e370c5cb47087e878ebe3130f5a7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 19677, "upload_time": "2018-02-02T17:34:38", "url": "https://files.pythonhosted.org/packages/89/6b/32deedaccc0f2cea5b05349234f87a5fd571124f499b0a53700024d474f3/nord-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1fefab3733c07048eb96cd95cf152619", "sha256": "363db13498f8c6c82fda4fecfb7e97bc696d43675528901319161aaf97e40cd9" }, "downloads": -1, "filename": "nord-0.2.0.tar.gz", "has_sig": false, "md5_digest": "1fefab3733c07048eb96cd95cf152619", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 44833, "upload_time": "2018-02-01T14:07:37", "url": "https://files.pythonhosted.org/packages/15/11/5fdff9bde723db4477ab0023f4141a618300d3e9488f60c8bbc49914d42a/nord-0.2.0.tar.gz" } ] }