Data

Tools

Indexes

Applications

Experiments

Open Source Science

vent

Vent is a light-weight platform built to automate network collection and analysis pipelines using a flexible set of popular open source tools and technologies. Vent is python-based, extensible, leverages docker containers, and provides both an API and CLI.

https://github.com/cyberreboot/vent

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 38 committers (5.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (21.7%) to scientific vocabulary

Keywords

automation cli containers deployment docker elasticsearch gpu pipeline-framework pipelines processing prototyping rabbitmq redis scheduling syslog tui

Keywords from Contributors

transformation reinforcement-learning geoscience distributed spectroscopy annotation astronomy bioinformatics research pypi
Last synced: 6 months ago · JSON representation

Repository

Vent is a light-weight platform built to automate network collection and analysis pipelines using a flexible set of popular open source tools and technologies. Vent is python-based, extensible, leverages docker containers, and provides both an API and CLI.

Basic Info
  • Host: GitHub
  • Owner: CyberReboot
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 16.8 MB
Statistics
  • Stars: 76
  • Watchers: 11
  • Forks: 35
  • Open Issues: 12
  • Releases: 0
Archived
Topics
automation cli containers deployment docker elasticsearch gpu pipeline-framework pipelines processing prototyping rabbitmq redis scheduling syslog tui
Created over 9 years ago · Last pushed about 6 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.md

vent

Network Visibility (an anagram)

Codacy Badge Build Status Documentation Status PyPI version codecov Docker Hub Downloads

Vent Logo

Overview

vent is a library that includes a CLI designed to serve as a general platform for analyzing network traffic. Built with some basic functionality, vent serves as a user-friendly platform to build custom plugins that perform user-defined processing on incoming network data. See this blog post - Introducing vent

Dependencies

bash docker>=1.13.1 git make (if building from source) pip3 python3.6.x

Installation

Option 1: Running inside of a Docker container

bash docker run -it -v /var/run/docker.sock:/var/run/docker.sock cyberreboot/vent

Option 2: Installing directly

bash pip3 install vent

Option 3: Getting the source and building

bash git clone https://github.com/CyberReboot/vent.git cd vent

Root/sudo users can simply run make to compile and install the platform. Users with limited permissions or require user-local installation can use the following:

bash sudo env "PATH=$PATH" make

Note - If you already have docker-py installed on your machine, you may need to pip uninstall docker-py first. vent will install docker-py as part of the installation process, however there are known incompatibilities of docker-py with older versions.

Running

bash vent

Plugins

vent supports custom plugins that perform user-defined processing on incoming data.

vent is filetype-agnostic in that the plugins installed within your specific vent instance determine what type of files your instance supports. Simply create your plugins, point vent to them & install them, and drop a file in vent to begin processing!

The vent-plugins repository showcases a number of example plugins and contains details on how to create your own.

Documentation

Want to read the documentation for vent? Great! You can find it here

Contributing to vent

Want to contribute? Awesome! Issue a pull request or see more details here.

See this for a crash course on npyscreen: the TUI used by Vent!

Owner

  • Name: Cyber Reboot
  • Login: CyberReboot
  • Kind: organization

Cyber Reboot has migrated to the broader IQT Labs org, for current and ongoing work see link below:

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 3,140
  • Total Committers: 38
  • Avg Commits per committer: 82.632
  • Development Distribution Score (DDS): 0.45
Top Committers
Name Email Commits
cglewis c****s@i****g 1,726
Jeffrey Wang j****3@g****m 253
pyup-bot g****t@p****o 247
Renovate Bot b****t@r****m 215
Chiraag Prafullchandra c****a@i****g 184
bpagon13 b****n@y****m 184
Chiraag Prafullchandra c****l@u****u 97
Joecakes4u j****u@g****m 96
Joe Wonohadidjojo j****o@i****g 26
Josh Bailey j****h@v****m 18
Charlie Lewis c****l@l****g 15
lilchurro a****g@i****g 12
Ryan Ashley r****y@i****g 10
xaver.fabian s****i@s****e 7
cominixo01 l****a@g****m 6
Usman Iqbal u****n@h****m 5
Danny Padilla d****0@g****m 5
Cece Hedrick c****k@g****m 3
the-zebulan t****n@u****m 3
Tranquilled l****9@g****m 3
Cody c****y@q****m 2
Arun Pattni a****1@g****m 2
Shaurya S****a@e****l 2
Edgard Mota e****a@g****m 2
Arpit Solanki s****7@g****m 2
root r****t@l****n 2
lilchurro l****o@u****m 2
Jeff Wang j****g@l****l 1
James Day g****t@j****e 1
Chiraag Prafullchandra c****a@D****l 1
and 8 more...
Committer Domains (Top 20 + Academic)
iqt.org: 6 edeltech.ch: 1 codacy.com: 1 cyberreboot.org: 1 jamesday.me: 1 labs-5470.labs.internal: 1 localhost.localdomain: 1 quantifiedcode.com: 1 stud.uni-saarland.de: 1 lab41.org: 1 vandervecken.com: 1 ucsd.edu: 1 renovateapp.com: 1 pyup.io: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 18
  • Total pull requests: 82
  • Average time to close issues: almost 2 years
  • Average time to close pull requests: about 9 hours
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.99
  • Merged pull requests: 79
  • Bot issues: 0
  • Bot pull requests: 51
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • cglewis (17)
  • cprafullchandra (1)
Pull Request Authors
  • renovate[bot] (51)
  • cglewis (24)
  • anarkiwi (7)
Top Labels
Issue Labels
area/administration (6) area/plugins (6) area/experience/developer (3) area/scalability (3) area/api (2) area/experience/user (2) area/learning/machine (2) area/rest (2) area/quality/maintainability (1) area/learning/deep (1) area/web (1) area/plugins/collection (1) area/testing (1) bug (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 107 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 2
    (may contain duplicates)
  • Total versions: 111
  • Total maintainers: 1
proxy.golang.org: github.com/cyberreboot/vent
  • Versions: 59
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 9.1%
Average: 9.7%
Dependent repos count: 10.3%
Last synced: 6 months ago
pypi.org: vent

A library that includes a CLI designed to serve as a platform to collect and analyze data across a flexible set of tools and technologies.

  • Versions: 52
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 107 Last month
Rankings
Forks count: 6.7%
Stargazers count: 8.0%
Dependent packages count: 10.0%
Average: 10.5%
Dependent repos count: 11.6%
Downloads: 16.4%
Maintainers (1)
cglewis
Last synced: 6 months ago

Dependencies

healthcheck/requirements.txt pypi
  • flask ==1.1.1
  • healthcheck ==1.3.3
setup.py pypi
  • docker >=4.0.2
  • npyscreen >=4.10.5
  • pyyaml >=5.1.2
test-requirements.txt pypi
  • docker ==4.1.0 test
  • elasticsearch ==7.1.0 test
  • falcon ==2.0.0 test
  • falcon-cors ==1.1.7 test
  • npyscreen ==4.10.5 test
  • pika ==1.1.0 test
  • pytest ==5.3.2 test
  • pytest-cov ==2.8.1 test
  • python-magic ==0.4.15 test
  • pyyaml ==5.2 test
  • redis ==3.3.11 test
  • rq ==1.1.0 test
  • sphinx ==2.3.1 test
  • urllib3 ==1.25.7 test
  • watchdog ==0.9.0 test
vent/core/file_drop/healthcheck/requirements.txt pypi
  • flask ==1.1.1
  • healthcheck ==1.3.3
  • six ==1.13.0
vent/core/file_drop/requirements.txt pypi
  • pika ==1.1.0
  • redis ==3.3.11
  • rq ==1.1.0
  • watchdog ==0.9.0
vent/core/rq_worker/healthcheck/requirements.txt pypi
  • flask ==1.1.1
  • healthcheck ==1.3.3
  • six ==1.13.0
vent/core/rq_worker/requirements.txt pypi
  • docker ==4.1.0
  • python-magic ==0.4.15
  • redis ==3.3.11
  • rq ==1.1.0
  • vent ==0.10.1
vent/extras/network_tap/healthcheck/requirements.txt pypi
  • flask ==1.1.1
  • healthcheck ==1.3.3
  • six ==1.13.0
vent/extras/network_tap/ncapture/requirements.txt pypi
  • pika ==1.1.0
vent/extras/network_tap/ncontrol/requirements.txt pypi
  • docker ==4.1.0
  • falcon ==2.0.0
  • falcon-cors ==1.1.7
  • gevent ==1.4.0
  • gunicorn ==20.0.4
vent/extras/rmq_es_connector/healthcheck/requirements.txt pypi
  • flask ==1.1.1
  • healthcheck ==1.3.3
  • six ==1.13.0
vent/extras/rmq_es_connector/requirements.txt pypi
  • elasticsearch ==7.1.0
  • pika ==1.1.0
  • urllib3 ==1.25.7
vent/extras/rq_dashboard/healthcheck/requirements.txt pypi
  • flask ==1.1.1
  • healthcheck ==1.3.3
  • six ==1.13.0