Skip to main content

Integration of controllers to drive tools.

Project description

build pypi

Metadrive

alt txt

alt txt

Metadrive helps users gather the information from different Internet resources (e.g. Linkedin, HTH Worldwide, etc). It provides one API to rule them all. To gather the information from this or that resource there must be so called driver written specifically for the resource. There are drivers which already exist. For example, * Halfbakery: halfbakery_driver * HTH Worldwide: hthworld_driver * Kompass: kompass_driver * Linkedin: linkedin_driver * Metaculus: metaculus_driver * ResearchGate: researchgate_driver * Versli Lietuva: verslilietuva_driver

Some of the drivers are awaiting to be implemented. Studying the Metadrive API will help developers to write the drivers for those resources which are needed them right now. A unified API is the killer feature of Metadrive and allows writing drivers to have a unified UI to the whole world.

Table of Contents

Prepare machine

sudo apt install virtualenv python3.7 python3.7-dev build-essential chromium-browser chromium-chromedriver

Installation

The guide provides for the instructions on how to install Metadrive to a virtual environment, so create and activate it first, running the following commands:

virtualenv -p python3.7 metadrive-env
. ./metadrive-env/bin/activate

Then, install Metadrive from its source code

git clone https://github.com/wefindx/metadrive.git
cd metadrive
pip install -e .

or from its package

pip install metadrive

Finally, run Metadrive, executing

provide

The command above will ask you to type your GitHub username. When you are done, the .metadrive/config will be created in your home directory and the server will start. The example of how .metadrive/config may look like:

[GITHUB]
username = mindey

[API]
host = 0.0.0.0
port = 7000

[CONSOLE]
host = 0.0.0.0
port = 7001

[DRIVER_BACKENDS]
chrome = /usr/bin/chromedriver

[PROXIES]
http =
https =

[GPG]
key = 5AFDB16B89805133F450688BDA580D1D5F5CC7AD

However, provide does not auto-reload and requires re-running, so if you want to run Metadrive for the development purposes, interrupt the provide process and execute the following command

uvicorn metadrive.api:app --debug

Installing drivers

After finishing the Metadrive installation you may check the drivers available right now.

$ curl http://127.0.0.1:7000/drivers
[]

So, there are no drivers and it’s ok since they have to be installed separately.

Choose one of the above-mentioned drivers. Let’s say it’s linkedin_driver. Execute the following command to install it

pip install linkedin_driver

and run the second-to-last command one more time

$ curl http://127.0.0.1:7000/drivers
[{"id":"http://0.0.0.0:7000/driver/linkedin-driver","site":"https://www.linkedin.com","package":"linkedin-driver==0.1.8"}]

Here’s the driver which has just been installed.

Documentation

The documentation for Metadrive can be found at https://metadrive.readthedocs.io.

Authors

See AUTHORS.

Licensing

metadrive is available under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metadrive-1.4.18.tar.gz (663.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page