adron / twitz Goto Github PK

A user information CLI Application written in Go using the Twitter API and Cassandra as a repository.

License: Apache License 2.0

Go 96.35% Shell 3.15% Makefile 0.49%

twitz's Introduction

Twitz

This application is about all of us lovely twitz on Twitter! A CLI tool to help introspect acounts to follow and make Twitter more useful to one's interests.

Installation

No official install process yet besides the ole' go get or go install method. I'll write more docs in the future when I get an official version released.

Dev Setup

Make sure you have Go modules enabled.
go build to build and use the executable.
Profit. i.e. use the CLI tool.

Post Installation Prerequisites

Once the command is built and ready for use, you'll need to get your .twitz.yaml, twitterers.txt, and export files configured.

First open up the .twitz.yaml file and set the values per your preferred file to parse and what file you want to export out to. An example .twitz.yaml file has the following values and some standard settings.

file: twitterers.txt
fileExport: tweeters
fileFormat: txt

Next is the twitterers.txt file. Which, depending on what you've set in the .twitz.yaml file might be named whatever you've designated it. A twitterers.txt file can have a pretty wide array of text in the file, but specifically it needs at least one Twitter account somewhere in the deluge of text. An example is included below.

This is a sample twitterers.txt file created by @Adron.

You can add a list like this; @Adron, @angryseattle, and @jessefraz or you could go horizontal!

@Adron
@angryseattle
@pdxtst

The result of that file would actually spit out something just like this when issuing the twitz parse command.

Using config file:  .twitz.yaml
[@Adron @Adron @angryseattle @jessefraz @Adron @angryseattle @pdxtst]

There is also a more elaborate example here.

Commands & Usage

First and foremost you'll need a text file of Twitter accounts listed in a file called twitterers.txt. This file will be parsed and pull out the accounts within the file. For more information on the file and the formatting check out twitterers file.

twitz will just list out some basic documentation, commands, and other information related to the CLI itself.

twitz config is a command that will show what is set in the .twitz.yaml configuration file.

twitz parse this is the main command that'll parse out the twitterers.txt file and provide a list of any Twitter accounts in the file to the console.

twitz findem this command retrieves Twitter account information from the Twitter API.

twitz cassie this command will retrieve Twitter information for the accounts and insert the data into an Apache Cassandra Database.

twitz's People

Contributors

Stargazers

Watchers

Forkers

venkyvb

twitz's Issues

The csv doesn't have commas!

This is a straight forward issue, it clearly isn't stepping through the if then correctly.

Fix the remaining export options for parse and findem.

Fix the current export issues around parse and findem.

Also needs refactoring.

Add Docker-Compose Support

Tweak the existing "Docker" setup so that docker-compose can be used to bring up the environment and bring down the environment.

Setup a map of commands for working against the database data.

Setup commands that map accordingly to the database.

twitz db twitter would prospectively get all of the Twitter accounts and list them to console.
twitz db instagram would prospectively get all the Instagram accounts and list them to console.

twitz db twitter -add @accountName would go to Twitter, get the account, and add the account with all the collected details.

twitz db twitter -getTweets would get the latest tweets from the users in the database by 5-10 users at a time with 3-5 second intervals between retrieval of those tweets.

Add more as ideas come up and add issues per idea. This issue should act as a parent issue item for tracking against.

Refactor existing commands under a "files" sub command structure.

Organize the existing parse form file, read and insert in cassandra from file, and related "file" manipulations and commands under a sub command such as shown below.

twitz file parse Read out the contents and print to console.
twitz file parse -f filename.txt Read out and export contents parsed from file to another file with the passed in -f parameter name.
twitz file cassie Takes accounts and writes/inserts them into the configured Apache Cassandra database.

This should act as a parent issue with sub-issues created for working through adding individual ideas of this feature.