Code Monkey home page Code Monkey logo

web-scrapper's Introduction

Web Scraper Hits

Web Scraper is a simple Flask-based API that allows users to retrieve meta data from any website by passing its URL as a request parameter.

How to Use the API

To use the API, simply make a GET request to the following endpoint:

https://web-scrapper-coral.vercel.app/api/read_web_meta_data?url={website_url}

Here, {website_url} refers to the URL of the website whose metadata you want to retrieve. The API returns a JSON object containing the website's title, description, and image etc.

For example, to retrieve the metadata for https://www.theverge.com, you would make the following request:

https://web-scrapper-coral.vercel.app/api/read_web_meta_data?url=https://www.theverge.com

Project Setup To set up the project, follow these steps:

  • Clone the repository to your local machine.
git clone https://github.com/TheAlphamerc/web-scrapper
  • Change into the project directory.
 cd web-scrapper 
  • Create a virtual environment and activate it.
python3 -m venv venv

`source venv/bin/activate

  • Install the project dependencies.
pip install -r requirements.txt
  • Setup the development environment by running these commands in your terminal.
export FLASK_APP=index.py
export FLASK_ENV=development
  • Run the Flask development server.
python app.py

The API will be accessible at http://127.0.0.1:5000/api/read_web_meta_data?url={website_url}.

Contributing Contributions to the project are welcome. If you'd like to contribute, please create a pull request with your changes.

Created & Maintained By

Sonu Sharma (Twitter) (Youtube) (Insta) (Dev.to) Twitter Follow

If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of โ˜•

You can also nominate me for Github Star developer program https://stars.github.com/nominate

Visitors Count

Loading

web-scrapper's People

Contributors

thealphamerc avatar

Watchers

 avatar  avatar  avatar

Forkers

dougdotcon

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.