AADBook -- Access your Azure AD contacts from the command line
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
aadbook
HACKING.md
LICENSE
MANIFEST.in
README.rst
requirements.txt
setup.cfg
setup.py

README.rst

aadbook -- access your Azure AD contacts from the command line.

About

AADBook is a fork of GooBook focusing on making it possible to use your Azure AD contacts from the command-line and from MUAs such as Mutt.

Installation Instructions

There is a number of ways to install Python software.

  • Using pip
  • Using a source tarball
  • Using source directly from gitorius
  • From a distribution specific repository

pip or easy_install

This is the recommended way to install aadbook for most users that don't have it available in their distribution. When installing this way you will not need to download anything manually.

Install like this:

pip install aadbook

Source installation

Download the source tarball, uncompress it, then run the install command:

tar -xzvf aadbook-*.tar.gz
cd aadbook-*
sudo python ./setup.py install

Configure

For most users it will be enough to to run:

aadbook authenticate

and follow the instructions.

To get access too more settings you can create a configuration file:

aadbook config-template > ~/.aadbookkrc

It will look like this:

# "#" or ";" at the start of a line makes it a comment.
[DEFAULT]
# The following are optional, defaults are shown

# This file is written by the Azure AD library, and should be kept secure,
# it's like a password to your AD contacts.
;auth_db_filename: ~/.aadbook_auth.json

;cache_filename: ~/.aadbook_cache
;cache_expiry_hours: 24

Proxy settings

If you use a proxy you need to set the https_proxy environment variable.

Mutt

If you want to use aadbook from mutt.

Set in your .muttrc file:

set query_command="aadbook query '%s'"

to query address book.

Usage

To query your contacts:

aadbook query QUERY

The cache is updated automatically according to the configuration but you can also force an update:

aadbook reload

For more commands see:

aadbook -h

and:

aadbook COMMAND -h

Changelog

0.1.2 (2018-11-01)

  • Switch to requests==2.20.0

0.1.1 (2018-10-21)

  • Fixed a bug where an exception thrown at startup when automatically refreshing auth tokens could make the authenticate command fail, leaving the user with no option other than wiping out aadbook caches

0.1.0 (2018-10-09)

  • Implement automatic fuzzy finding by replacing each `` `` in the search query string with .*

0.0.3 (2018-10-01):

  • Fix a bug where internal credentials were not properly updated after tokens were updated using the refreshToken -- throwing an error on the first aadbook query ... invocation

0.0.2 (2018-09-16):

  • The authenticate command now always initiates a full authentication workflow, irrespective of any cached token
  • Start up time has improved thanks the the internal token now being refreshed only when expired

0.0.1 (2018-09-08):

  • Project inception