<commit_before>=============
SPA Phone API
=============

SPA Phone API provides an API for Linksys/Sipura SPA IP Phones. It can be used
to programmatically update the phone's address book. Combining it into other
scripts it can be used to sync the phone's address book with (for example)
Google Contacts.

Installation
============

Installation with ``pip``:
::

    $ pip install spa-phone-api


Usage
=====

Read the address book
::

    import spa_phone
    spa_phone.read('10.0.1.8')

Update the address book
::<commit_msg>Updated readme to include section about command line usage<commit_after>=============
SPA Phone API
=============

SPA Phone API provides an API for Linksys/Sipura SPA IP Phones. It can be used
to programmatically update the phone's address book. Combining it into other
scripts it can be used to sync the phone's address book with (for example)
Google Contacts.

Installation
============

Installation with ``pip``:
::

    $ pip install spa-phone-api


Command Line Usage
==================

Update the address book from OS X Contact. Defaults to sync all contacts, but
an optional group paramater can be specified.
::

    $ spa-sync ip-address [--group]

Usage
=====

Read the address book
::

    import spa_phone
    spa_phone.read('10.0.1.8')

Update the address book
::
{'fraction_non_alphanumeric': 0.13925019127773527, 'fraction_numerical': 0.0076511094108645756, 'mean_word_length': 4.109375, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2032693', 'n_tokens_mistral': 394, 'n_tokens_neox': 362, 'n_words': 165}