Skip to main content

A Python package for programmatically controlling NordVPN.

Project description

Njord Python Package

Overview

The njord python package provides a convenient wrapper to programmatically working with NordVPN servers on Mac/Linux via OpenVPN.

Prerequisites

  • sudo
  • openvpn

Because njord relies on sudo and openvpn, it only works on OSX (including Apple silicone) and Linux. Linux is currently untested. Nord has an official client that may better serve your needs on Linux. Windows isn't supported.

Installing OpenVPN

OSX

$ brew install openvpn

Ubuntu

$ sudo apt-get install openvpn

Installation

$ pip install njord

Usage

Authentication

Authentication is handled via service credentials. Generate these via your Nord account at Services > NordVPN > Manual Setup

Copy the service credentials username and password. It's reccomended that you use a .env file for storing them. Njord will check for a .env file on initialization as well as os env variables. Authentication can also be done explicitly during init.

# .env
NORD_USER=xxxxxxxxxxxxx
NORD_PASSSWORD=xxxxxxxxxxx
from njord import VPN

# Using .env file or os env
vpn = VPN()

# Explicit
vpn = VPN(user="xxxxxxxx", password="xxxxxxxxx")

Connecting & Disconnecting

from njord import VPN
vpn = VPN()
vpn.connect()
vpn.protected()
>> True
vpn.disconnect()
vpn.protected()
>> False

MIT License

Copyright (c) 2023 Adam Smith

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

njord-0.0.2.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

njord-0.0.2-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file njord-0.0.2.tar.gz.

File metadata

  • Download URL: njord-0.0.2.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for njord-0.0.2.tar.gz
Algorithm Hash digest
SHA256 7ede33eba5972e8051bbd497d2959c514c7bd96f36d86a1e0be15a32ec7a32b6
MD5 c3a2c2547f252e189fad6e5347d4f9de
BLAKE2b-256 ac808deda3f1efb3408003f02607e584f8e4ace59f76ad08d2318a0559a732b3

See more details on using hashes here.

File details

Details for the file njord-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: njord-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for njord-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5665c474ee85eb8ea99e2c9e5e75ab9c74cb3406b13897fc84749fbd0ac34ed4
MD5 1789fcfa109317769324ea90158b8d6c
BLAKE2b-256 0870a7bc4de0ac86baf6ae23636dded78e82ab9983c81447932fa7846f1e9e48

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page