Giter Club home page Giter Club logo

website-analyzer-app's Introduction

Website Analyzer Flask App Python 3.11.2 License Status

A Flask-based service to retrieve domain-specific information.

Table of Contents

  1. Features
  2. Dependencies
  3. Setup
  4. Usage
  5. Running the Server
  6. Limitations and Caveats
  7. Testing
  8. License

Features

  1. Query domain info via a GET request.
  2. Interactive WebSocket for domain data.
  3. Built-in URL validation.
  4. Multi-threaded for concurrent requests.

Dependencies

  1. Python 3.11.2
  2. Refer to requirements.txt for the full list of dependencies.

Setup

  1. Ensure Python is installed.
  2. Create a virtual environment: python -m venv venv
  3. Install necessary packages in the virtual environment: pip install -r requirements.txt
  4. Get an API key from https://www.whoisxmlapi.com/.
  5. Set the environment variable (or in the .env file) API_KEY to the API key.

Usage

RESTful Endpoint

Retrieve domain info: GET /?url=<DOMAIN_NAME>

Replace <DOMAIN_NAME> with the target domain.

WebSocket Service

  1. Connect to the /ws endpoint.
  2. Initiate a domain session with a JSON containing the url key.
  3. Send operations using the operation key in the message:
    • get_info for basic details.
      {
          "operation": "get_info"
      }
      
    • get_subdomains for subdomains.
      {
          "operation": "get_subdomains"
      }
      
    • get_asset_domains for asset domains.
      {
          "operation": "get_asset_domains"
      }
      

Running the Server

Launch the server with:

python <filename>.py Access at http://localhost:5000/.

Limitations and Caveats

No authentication or rate-limiting; not advisable for production usage. Errors are JSON-formatted with the error key.

Testing

Run the test suite with: python -m pytest

License

Open source. See the LICENSE file.

website-analyzer-app's People

Contributors

50fifty avatar

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.