Welcome to Socials’s documentation!

Socials

https://img.shields.io/pypi/v/socials.svg https://img.shields.io/travis/lorey/socials.svg 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.

Installation

Stable release

To install Socials, run this command in your terminal:

$ pip install socials

This is the preferred method to install Socials, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Socials can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/lorey/socials

Or download the tarball:

$ curl  -OL https://github.com/lorey/socials/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use Socials in a project:

import socials

Let’s assume that you have a list of href attribute values:

>>> hrefs = ['https://facebook.com/peterparker', 'https://techcrunch.com', 'https://github.com/lorey']

You can then extract all matches, i.e. social accounts and email addresses, as follows:

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

Or to extract matches for one specific platform only, e.g. github, you do:

>>> socials.extract(hrefs).get_matches_for_platform('github')
['https://github.com/lorey']

socials

socials package

Submodules

socials.cli module

socials.socials module

Main module.

class socials.socials.Extraction(hrefs)[source]

Bases: object

Extracted profiles.

get_matches_for_platform(platform)[source]

Find all matches for a specific platform.

Parameters:platform – platform to search for.
Returns:list of matches.
get_matches_per_platform()[source]

Get lists of profiles keyed by platform name.

Returns:a dictionary with the platform as a key, and a list of the platform’s profiles as values.
socials.socials.clean_mailto(href)[source]
socials.socials.extract_matches_for_platform(platform, hrefs)[source]
socials.socials.extract_matches_per_platform(hrefs)[source]

Get lists of profiles keyed by platform name.

Parameters:hrefs – hrefs to parse.
Returns:a dictionary with the platform as a key, and a list of the platform’s profiles as values.
socials.socials.get_cleaner(platform)[source]
socials.socials.get_platform(href)[source]
socials.socials.is_platform(href, platform)[source]

Module contents

Top-level package for Socials.

socials.extract(urls)[source]

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/lorey/socials/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Socials could always use more documentation, whether as part of the official Socials docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/lorey/socials/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up socials for local development.

  1. Fork the socials repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/socials.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv socials
$ cd socials/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 socials tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/lorey/socials/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_socials

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

History

0.2.0 (2018-05-31)

  • Email address extraction.
  • Extraction of specific platforms.

0.1.0 (2018-05-18)

  • First release on PyPI.

Indices and tables