Offray/Socialmetrica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Minidoc started

Browse Source
This commit is contained in:
Offray Vladimir Luna Cárdenas 2021-09-03 09:43:56 -05:00
parent 9e746738c9
commit fa90cd4cb4
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -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: To install, first install [ExoRepo](https://code.tupale.co/Offray/ExoRepo) and then from a _playground_ in [GToolkit](https://gtoolkit.com/) execute:
```smalltalk ```smalltalk
ExoRepo new ExoRepo new
repository: 'https://code.tupale.co/Offray/Datanalitica'; repository: 'https://code.tupale.co/Offray/Datanalitica';
load. 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'
```