Git Product home page Git Product logo

vanilla-forum-search's Introduction

Vanilla Forum Search Script

This repository contains a Python script to search discussions and comments in a Vanilla forum within the past two weeks for specific keywords. The script then returns the results as a pretty-printed JSON object.

Prerequisites

  • Python 3.x
  • requests library

Installation

  1. Clone the repository to your local machine:
git clone https://github.com/ohnotnow/vanilla-forum-search.git
cd vanilla-forum-search
  1. Install the required dependencies:
pip3 install requests

(Depending on your install it might just be pip - and indeed just python below)

Configuration

You need to set an environment variable with the base of your vanilla install. Eg,

export VANILLA_URL="https://vf.example.com"

Usage

Run the script with the keywords you want to search for:

python3 ./main.py word1 word2 word3

The script will search for discussions from the past two weeks and comments containing the specified keywords, and then output the results as a JSON object. If you want a more 'plain text' result you can use jq :

python3 main.py word1 word2 word3 | jq -r '.[] | .Thread, (.Matches[] | "Keywords: \(.keywords)", "Comment URL: \(.comment_url)", "Embedded URLs: \(.embedded_urls | join(", "))")'

License

MIT.

vanilla-forum-search'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.