Skip to content

Latest commit

 

History

History
72 lines (46 loc) · 2.27 KB

README.rst

File metadata and controls

72 lines (46 loc) · 2.27 KB

Socials

Documentation Status

Social Account Detection and Extraction for Python

Features

  • Detect and extract URLs of social accounts: throw in URLs, get back URLs of social media profiles by type.
  • Currently supports Facebook, Twitter, LinkedIn, GitHub, and Emails.

Usage

Install it with pip install socials and use it as follows:

>>> hrefs = ['https://facebook.com/peterparker', 'https://techcrunch.com', 'https://github.com/lorey']
>>> socials.extract(hrefs).get_matches_per_platform()
{'github': ['https://github.com/lorey'], 'facebook': ['https://facebook.com/peterparker']}
>>> socials.extract(hrefs).get_matches_for_platform('github')
['https://github.com/lorey']

Read more about usage in our documentation.

Socials API

There's also an API called Socials API that allows you to use the functionality via REST. You can use a free online version, try it in the browser, or deploy it yourself.

Development

  • Create virtual envirenment venv with virtualenv -p /usr/bin/python3 venv.
  • Activate the environment with source venv/bin/activate.
  • Install the development requirements with pip install -r requirements-dev.txt.
  • Run the tests: tox or python setup.py test

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.