Giter VIP home page Giter VIP logo

irclogparser's Introduction

IRCLogParser

Build Status Maintainability Requirements Status
Unit-Test - codecov Integration-Test - coverage Functional-Test - test coverage

The objective of this project is to utilize social network analysis techniques to examine the relationships between actors on the Internet Relay Chat(IRC) social networking service. The IRCLogParser is an application that accepts IRC log files from different channels and parses them to analyse the principles of interaction between IRC users. Study of these interactions on different levels helps us in deriving the local and global communication patterns between users on different channels. Therefore, IRCLogParser draws its inspiration from various fields such as data mining, graph theory and inferential modeling in order to form predictive models that help in understanding certain intricate characteristics of a social network. This involves analyzing graphs with IRC users(nodes) and their connections(edges), to study the details about various network graph properties such as density, size, node centrality, degree, connectedness etc.

Documentation

IRCLogParser uses Sphinx Python Documentation Generator for generating documentation of the library. The documentation is auto-generated from the commits made on the dev branch. Please see the online documentation.

Installation

IRCLogParser depends on various third-party libraries which are handled by setup.py. Run the "install.sh" script present in [script](./script] directory to install these dependencies and other OS level dependencies for the third-party libraries.

Follow the steps to install dependencies and IRCLogParser library:- git clone https://github.com/prasadtalasila/IRCLogParser.git cd IRCLogParser bash script/install

Ideally the installation takes not more than 10 minutes.

Testing

Presently, IRCLogParser has various end-to-end implemented which reside in the test directory.

To run the all the tests locally on your machine, execute : python -m unittest -v discover -s test/ in the root directory.

To run a particular test, execute : python -m unittest -v location_to_test in the root directory.

Running all the unit & integration tests require 3-5 minutes.

Usage

The library's working has been modularised into many modules namely input, analysis, output, visualisation and validation. The sample.py file very comprehensively presents how one can use IRCLogParser for parsing and analysis.

A page on typical workflow for using IRCLogParser also exists on the documentation here.

To run and test the sample program, execute in root directory : python sample.py

License

IRCLogParser is available under the GPL v3.0

irclogparser's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.