README.md

Mycroft-Social-Network-Manager

Mycroft-Social-Network-Manager is a skill developped for Mycroft

Description

It permits the user to manage his social networks (for now, Twitter and Facebook) through Mycroft personal assistant WITH YOUR VOICE !

Usage

Thanks to Mycroft-Social-Network-Manager, you can interact with Mycroft in such ways :

The following works with both Twitter and Facebook, the skill will ask you on which social network you want to perform the action ! (Facebook, Twitter or Facebook and Twitter | both)

• Login to twitter and facebook

  Login

• Logout from twitter and facebook ( !! Be careful with the use of logout, it will erase the facebook and twitter app access tokens you have entered in Mycroft Home !! )

  Logout

• Send a message to a friend

  Message [message_text] to [friend_name]

  Send [message_text] to [friend_name]

  Text [message_text] to [friend_name]

• Post / tweet something on your wall

  Post [message_text]

  Publish [message_text]

• Post / tweet something to a friend's wall (tags the friend in your tweet on Tweeter)

  Share [message_text] to [friend_name]

The following works with Facebook only

• Comment something on a friend profile picture

  Comment [message_text] on [friend_name] profile picture

  Comment [message_text] on [friend_name] pic

  Comment [message_text] on [friend_name] photo

• Like a friend profile picture

  Like the profile picture of [friend_name]

  Like the pic of [friend_name]

  Like the photo of [friend_name]

• Know your number of friends of Facebook

  How many friends do I have on Facebook ?

The following works with Twitter only

• Retweet the last tweet of a friend

  Retweet [friend_name]

• Reads the last tweet of a friend

  Get the last tweet of [friend_name]

Installation

Mycroft-Social-Network-Manager requires Mycroft-core to run.

In order to install the skill :

$ cd mycroft-core/msm/
$ ./msm install https://github.com/ldevalbray/mycroft-social-network-manager

Installing Mycroft-Social-Network-Manager skill should automatically install browser_service, another skill that you'll need to run Mycroft-Social-Network-Manager.

However, browser_service should be made into a priority skill in the mycroft config file :

$ cd mycroft-core/mycroft/configuration/

Open the mycroft.conf file with your favourite text editor

    // General skill values
      "skills": {
        ...
        // priority skills to be loaded first
        "priority_skills": ["skill-pairing", "browser_service"],
        ...
      },

Requirements

In order to run the skill you will need to create two apps, one on Facebook and one on Twitter.

Once this done, you will need to configure facebook login module on the facebook app and configure it for devices (Activate " Login from Devices" in your Facebook Login settings).

Then, all what's left to do is enter those informations in Mycroft Home

    {
        "name": "LoginFB",
        "fields": [
            {
                "name": "FacebookEmail",
                "type": "email",
                "label": "Email",
                "value": ""
            },
            {
                "name": "FacebookPassword",
                "type": "password",
                "label": "Password",
                "value": ""
            },
            {
                "name": "fbAppAccessToken",
                "type": "text",
                "label": "Facebook App Access Token",
                "value": ""
            }
        ]
    },
    {
        "name": "LoginTW",
        "fields": [
            {
                "name": "TwitterEmail" ,
                "type": "email",
                "label": "Email",
                "value": ""
            },
            {
                "name": "TwitterPassword",
                "type": "password",
                "label": "Password",
                "value": ""
            },
            {
                "name": "TwitterPhoneNumber",
                "type": "text",
                "label": "Phone Number",
                "value": ""
            },
            {
                "name": "twConsumerKey",
                "type": "text",
                "label": "Twitter App Consumer Key",
                "value": ""
            },
            {
                "name": "twConsumerSecret",
                "type": "text",
                "label": "Twitter App Consumer Secret",
                "value": ""
            }
        ]
    }

NOTE : The Facebook App Access Token is your app id concatenated with your client token (can be found in the app advanced settings) : [your_app_id|client_Token]

In order for the skill to fully work, all those informations should be entered.

Testing

For testing, we use Mycroft automatic testing. All the tests are in mycroft-social-network-manager/test/intent/

In order to test the skill, you will need to switch branch on Mycroft-core to feature/carstens-skill-tester

git checkout origin/feature/carstens-skill-tester

(You'll maybe need to redo the changes to mycroft.conf we've done in the master/dev branch about the priority skills --> see Instalation)

Then, go to mycroft-core/test/integrationtests/skills/, start Mycroft virtualenv and run skill_developers_testrunner.py

cd /test/integrationtests/skills/
workon mycroft
python skill_developers_testrunner.py

This should run the tests

Tech

Mycroft-Social-Network-Manager uses a number of open source projects and languages to work properly:

• [Python] - The Mycroft language
• [python-twitter] - A Twitter SDK made for Python
• [Facebook SDK for Python] - A Facebook SDK made for Python
• [Selenium] - Using selenium threw a Mycroft skill called browser_service
• [fbchat] - Library that uses Selenium to send messages to facebook friends
• [Levenshtein] - In order to compare Strings

And of course Mycroft-Social-Network-Manager itself is open source with a public repository on GitHub.