From fa90cd4cb45f9a46f2a9620cba09f31523dca274 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Offray=20Vladimir=20Luna=20C=C3=A1rdenas?= Date: Fri, 3 Sep 2021 09:43:56 -0500 Subject: [PATCH 1/2] Minidoc started --- README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e96121f..0a0d289 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,29 @@ Social Networks data analysis utilities and tools, starting with Twitter. To install, first install [ExoRepo](https://code.tupale.co/Offray/ExoRepo) and then from a _playground_ in [GToolkit](https://gtoolkit.com/) execute: ```smalltalk - ExoRepo new - repository: 'https://code.tupale.co/Offray/Datanalitica'; - load. -``` \ No newline at end of file + ExoRepo new + repository: 'https://code.tupale.co/Offray/Datanalitica'; + load. +``` + +## Minimal usage example + +**Prerequisite**: You will need to have already your [Twitter API Keys](https://developer.twitter.com/en/support/twitter-api). + +Load your API keys into a `TwitterAPI` object: + +```smalltalk + twitterAPI := TwitterAPI new + apiKeysFile: FileLocator home / 'Route/To/myAPIKeysFile.json'; + loadKeys. +``` + + (If you don't define a particular route to your API keys file, it will be loaded from a default location + in : `~/.config/Datanalitica/twitter-api-keys.json`) + + Once you have loaded your keys, you can run your first query using the DSL (Domain Specific Lanuage): + +```smalltalk + twitterAPI usersGroupMentioning: 'feenkcom' +``` + From 1a887dd344b7fc22f428b9896472ec9096682412 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Offray=20Vladimir=20Luna=20C=C3=A1rdenas?= Date: Fri, 3 Sep 2021 09:56:17 -0500 Subject: [PATCH 2/2] Details view --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0a0d289..914e47d 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,11 @@ Load your API keys into a `TwitterAPI` object: twitterAPI usersGroupMentioning: 'feenkcom' ``` +![Running the MiniDoc example](https://i.imgur.com/SjMzR4X.png) + +If you click in a particular user, you can get details on him/her and an overview of his/her tweets, +and clicking on a particular tweet you can see details on it: + +![Exploring further details](https://i.imgur.com/89EInrp.png) + +That is for now. Next some support for topic modelling and clustering will be added. \ No newline at end of file