{ "info": { "author": "Yan Orestes", "author_email": "yan.orestes@alura.com.br", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Natural Language :: Portuguese (Brazilian)", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Internet" ], "description": "botblocker\n==========\n\nPython program to identify and block your bot followers on Twitter\n\nRequires 3.4 <= Python <= 3.7\n\nGetting Started\n---------------\n\nThese instructions will get you a copy of the project up and running on\nyour local machine for development and testing purposes.\n\nInstalling\n~~~~~~~~~~\n\n**Only if you use Python >= 3.7, you have to run this command first:**\n\n::\n\n sudo pip install https://github.com/tweepy/tweepy/archive/master.zip\n\nNow, no matter what Python version you're using (if it fits the requirement), the easiest way is installing using pip:\n\n::\n\n sudo pip install botblocker\n\nYou can also clone this project using git:\n\n::\n\n git clone https://github.com/yanorestes/botblocker.git\n cd botblocker\n python setup.py install\n\nPreparation\n-----------\n\nAt first, setting things up to botblocker may sound overcomplicated.\nHowever, following this step-by-step tutorial will ensure an easy\nproceedment! Still, this \u201chard\u201d part of the tutorial will have to be\nfollowed only once ;)!\n\n1 - Getting your Twitter Developer Account\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAs I\u2019m providing the complete code of this project, I can\u2019t let you guys\nuse my API keys, so you need to get them yourselves. This is how you do\nit:\n\n- Access `this link `__ to\n associate your Twitter profile with a developer account\n- Click in ``Continue``\n- Check \u201cI am requesting access for my own personal use\u201d\n- Type in your username on the field below\n- Select the country you live and press ``Continue``\n- Check \u201cConsumer / end-user experience\u201d\n- In the textbox below, type something similar to the following example\n (note that it is better not to copy the whole text, so that your\n application will be approved faster):\n\n::\n\n The project I'm building aims to identify and block follower bots. It is based on programming language Python, using Tweepy to connect to Twitter API and Botometer to identify bots. The project gives the user mutiple options on identifying and blocking the bots, resulting in a clean and simple usage. Botometer analizes each profile basing itself on the tweets and the specs of the profile, to, then, calculate a result (a score from 0 to 5; the higher, the more likely it is that the profile is indeed a bot). None of the results are shared with anyone or kept with us.\n\n- Check ``No`` and click ``Continue``\n- Scroll through the terms of service and check the \u201cread and agree\u201d\n box\n- Click on \u201cSubmit application\u201d\n- Check your email account and confirm your email\n- Wait for your Developer Account to get approved\n\n2 - Getting your Twitter API Keys\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOnce your Developer Account gets approved, you can pass on to creating\nan app:\n\n- Access `this link `__\n to register your app\n- Chose an authentic name to your app and fill the first field\n- In the textbox below, type something similar to the following\n example:\n\n::\n\n Python program to identify and block your bot followers on Twitter.\n\n- Paste https://github.com/yanorestes/botblocker on the field below\n- Skip to the last textbox and type in something similar to the\n following example:\n\n::\n\n The project I'm building aims to identify and block follower bots. It is based on programming language Python, using Tweepy to connect to Twitter API and Botometer to identify bots. The project gives the user mutiple options on identifying and blocking the bots, resulting in a clean and simple usage.\n\n- Click on ``Create`` and confirm\n\nYou will be redirected to your app\u2019s page. Then:\n\n- Access the \u201cKeys and tokens\u201d tab\n- Save the two keys under \u201cConsumer API keys\u201d somewhere. The first is\n your Consumer Key and the second is your Consumer Secret Key. You\n will need both of them later configuring botblocker:\n\n.. image:: https://cdn.pbrd.co/images/HEvDXKu.png\n\n3 - Getting your Mashape API Key\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nWith your Twitter API keys in hands, you\u2019ll only have to get your\nMashape API Key. Follow these steps in order to do so:\n\n- Access `this link `__ and register an\n account (I recommend signing up with GitHub, but there are other\n options)\n- If you have a credit card available (**you won\u2019t have to pay a single\n dollar, don\u2019t worry!**), access `this\n link `__, click on\n ``Pricing`` and subscribe to the Basic Free Plan. If you don\u2019t, you\n can use `this link `__.\n The first link will (probably) make the program run faster.\n- On `this link `__, copy\n your personal \u201cX-Mashape-Key\u201d on the request example code and save\n somewhere:\n\n.. image:: https://my.mixtape.moe/nqkagq.png\n\nUsing\n-----\n\nNow it\u2019s time to finally run botblocker! Botblocker you\u2019ll go through\nall of your followers and calculate a \u201cbot score\u201d of them. The score\ngoes from 0 to 5. The higher the score, the more likely is the chance\nthe profile is a bot. The default behaviour is to automatically block every profile identified as a bot.\n\nIf you installed the package using pip, you can simply run botblocker in\nthe command line:\n\n::\n\n botblocker [-h] [-c] [--noblock] [--saveallowlist] [--softblock] [--report] [-l {1,2,3}] -u USER [-v]\n\nThese are the parameters you can use:\n\n- ``-h`` or ``--help`` - Shows a help message and exit\n- ``-c`` or ``--config`` - (Re)configure usage settings. At least once,\n you\u2019ll have to do this.\n- ``--noblock`` - Don\u2019t block anyone automatically. This is not recommended, especially for profiles with lots of followers, as you may lose all the running progress if you exit early.\n- ``--saveallowlist`` - Save users identified as non-bots to an\n allowlist. Recommended.\n- ``--softblock`` - Do soft block (block and unblock right after)\n- ``-r`` or ``--report`` - Report users identified as bots to Twitter\n- ``-l {1,2,3}`` or ``-level {1,2,3}`` - Choose level of rigorosity to\n use to identify bots. Level 1 only consider bots those with score >=\n 4, level 2 (default) considere those with score >= 3 and level 3\n considere those with score >= 2.5.\n- ``-u USER`` or ``-user USER`` - The Twitter username you want to run\n botblocker for. Required.\n- ``-v`` or ``--version`` - Get the current version of botblocker\n\nYou can also run the script directly by ``botblocker.py``:\n\n::\n\n python -W ignore -m botblocker [-h] [-c] [--noblock] [--saveallowlist] [--softblock] [--report] [-l {1,2,3}] -u USER [-v]\n\nContributing\n------------\n\nI\u2019m accepting pull requests that improve speed and legibility of the\ncode.\n\nAuthors\n-------\n\n- **Yan Orestes** - *Initial work* -\n `yanorestes `__\n\nLicense\n-------\n\nThis project is licensed under the MIT License - see the\n`LICENSE `__\nfile for details.", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/yanorestes/botblocker/archive/1.1.3.zip", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/yanorestes/botblocker", "keywords": "twitter bot blocker tweepy botometer", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "botblocker", "package_url": "https://pypi.org/project/botblocker/", "platform": "", "project_url": "https://pypi.org/project/botblocker/", "project_urls": { "Download": "https://github.com/yanorestes/botblocker/archive/1.1.3.zip", "Homepage": "https://github.com/yanorestes/botblocker" }, "release_url": "https://pypi.org/project/botblocker/1.1.3/", "requires_dist": null, "requires_python": ">= 3.4", "summary": "Python script to identify and block your bot followers on Twitter", "version": "1.1.3" }, "last_serial": 4290849, "releases": { "1.1.2": [ { "comment_text": "", "digests": { "md5": "6cabc0315f503f1a766948b1073f3922", "sha256": "8f66421c3af901dd19fed8a14e2169fd428898b2f9148e7cccd7cdc13714ec60" }, "downloads": -1, "filename": "botblocker-1.1.2.tar.gz", "has_sig": false, "md5_digest": "6cabc0315f503f1a766948b1073f3922", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.4", "size": 8704, "upload_time": "2018-09-19T17:25:23", "url": "https://files.pythonhosted.org/packages/bd/39/bae18b53dc2a324b1d550a270e67bff080f50d36313ba4bebb600d4e4e0b/botblocker-1.1.2.tar.gz" } ], "1.1.3": [ { "comment_text": "", "digests": { "md5": "de48dbd8efe666d4c9dc8fd62a028230", "sha256": "26ccb485e356a8ff84c39419ee42a9e7e2dfcfb9b8a63a9cc09752b823f38ef6" }, "downloads": -1, "filename": "botblocker-1.1.3.tar.gz", "has_sig": false, "md5_digest": "de48dbd8efe666d4c9dc8fd62a028230", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.4", "size": 8899, "upload_time": "2018-09-20T01:01:26", "url": "https://files.pythonhosted.org/packages/d0/f8/6e6c9baa5f2c3a62d8e16bfb5c81bd27acc130ab3eac2a84ddf452221fb9/botblocker-1.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "de48dbd8efe666d4c9dc8fd62a028230", "sha256": "26ccb485e356a8ff84c39419ee42a9e7e2dfcfb9b8a63a9cc09752b823f38ef6" }, "downloads": -1, "filename": "botblocker-1.1.3.tar.gz", "has_sig": false, "md5_digest": "de48dbd8efe666d4c9dc8fd62a028230", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.4", "size": 8899, "upload_time": "2018-09-20T01:01:26", "url": "https://files.pythonhosted.org/packages/d0/f8/6e6c9baa5f2c3a62d8e16bfb5c81bd27acc130ab3eac2a84ddf452221fb9/botblocker-1.1.3.tar.gz" } ] }