OnePassword python client
Python client around the 1Password password manager cli for usage within python code and Jupyter Notebooks. Developed by Data Scientists from Jamf.
Supported versions
There are some of the pre-requisites that are needed to use the library. We automatically install the cli for Mac and Linux users when installing the library. Windows users see below for help.
- 1Password App: 8+
- 1Password cli: 2+
- Python: 3.10+
Operating systems
The library is split into two parts: installation and client in which we are slowly updating to cover as many operating systems as possible the following table should ensure users understand what this library can and can't do at time of install.
| | MacOS | Linux | |------------------|-------|-------| | Fully supported | Y | Y | | CLI install | Y | Y | | SSO login | Y | Y | | Login via App | Y | Y | | Biometrics auth | Y | Y | | Password auth | Y | Y | | CLI client | Y | Y | | Service account | Y | Y |
Installation
pip install 1passwordIf you have issues with PyYaml or other distutils installed packages then use:
pip install --ignore-installed 1passwordYou are welcome to install and manage op yourself by visiting the CLI1 downloads page to download the version you require and follow instructions for your platform as long as it's major version 2.
The above commands pip commands will check op is present already and if not will install the supported op cli plus the python client itself. This is currently fixed at op version 1.12.5 to ensure compatibility. If you wish to use a higher version of op you can by following this guide, however note that we cannot ensure it will work with our client yet.
MacOS users will be prompted with a separate installation window to ensure you have a signed version of op - make sure to check other desktops that the installer might pop up on.
Optional pre-requisites
#### base32 This utility is used to create a unique guid for your device but this isn't a hard requirement from AgileBits and so if you see base32: command not found an empty string will be used instead, and the client will still work fully.
If you really want to, you can make sure you have this installed by installing coreutils. Details per platform can be found here: https://command-not-found.com/base32