==============
sopel-iplookup
==============
Sopel plugin ``.ip`` command::
16:22 <SnoopJ> !ip 8.8.8.8
16:22 <testibot> [IP/Host Lookup] Downloading GeoIP database, please wait...
16:22 <testibot> [IP/Host Lookup] Hostname: dns.google | Location: United States | ISP: AS15169 GOOGLE
Install
=======
The recommended way to install this plugin is to use ``pip``::
$ pip install sopel-iplookup
Note that this plugin requires Python 3.7+ and Sopel 7.1+. It won't work on
Python versions that are not supported by the version of Sopel you are using.
Configure
=========
``sopel-iplookup`` can be configured by invoking Sopel's interactive wizard::
$ sopel-plugins configure iplookup
Configure Sopel GeoIP Lookup Plugin
Please consult sopel-iplookup's README to learn about its settings.
Path to existing GeoIP db files (leave empty to auto download):
MaxMind license key (optional): (hidden input)
By default, ``sopel-iplookup`` will look in a few standard locations for GeoIP
database files. If it can't find existing database files, it will download them
from an automated mirror on GitHub.
You can optionally provide your own MaxMind license key, and the plugin will
download directly from them instead. Alternatively, if your OS distribution
already has GeoIP database files kept up-to-date by the system package manager,
you can provide the path where those files are stored.
Notes
=====
This plugin replaces a built-in Sopel plugin formerly called ``ip``, you may need
to update your bot configuration to replace ``ip`` with ``iplookup`` if you are e.g.
excluding this plugin.
Changelog
=========
1.1.0
-----
* plugin, config: add config field for MaxMind license key (#4, #5)
* If no MaxMind key is provided, the plugin will download from a mirror of
the .mmdb files on GitHub. With a license key, the plugin downloads directly
from MaxMind.
* plugin: slightly better logging during/after DB downloads
* meta: add automated release workflow using PyPI Trusted Publishing (#7)
1.0.0
-----
Initial release. Replaces ``ip`` plugin formerly shipped as part of ``sopel``.
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-iplookup",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": "dgw <dgw@technobabbl.es>, Florian Strzelecki <florian.strzelecki@gmail.com>, SnoopJ <snoopjedi@gmail.com>",
"keywords": "sopel, plugin, bot, irc",
"author": "Dimitri Molenaars",
"author_email": "Elad Alfassa <elad@fedoraproject.org>, dgw <dgw@technobabbl.es>, Florian Strzelecki <florian.strzelecki@gmail.com>, SnoopJ <snoopjedi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/40/d4/515fe802850bf219e0952817ece3ae3fa9b7b3c69b324afd611869a1a062/sopel_iplookup-1.1.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "==============\nsopel-iplookup\n==============\n\nSopel plugin ``.ip`` command::\n\n 16:22 <SnoopJ> !ip 8.8.8.8\n 16:22 <testibot> [IP/Host Lookup] Downloading GeoIP database, please wait...\n 16:22 <testibot> [IP/Host Lookup] Hostname: dns.google | Location: United States | ISP: AS15169 GOOGLE\n\nInstall\n=======\n\nThe recommended way to install this plugin is to use ``pip``::\n\n $ pip install sopel-iplookup\n\nNote that this plugin requires Python 3.7+ and Sopel 7.1+. It won't work on\nPython versions that are not supported by the version of Sopel you are using.\n\nConfigure\n=========\n\n``sopel-iplookup`` can be configured by invoking Sopel's interactive wizard::\n\n $ sopel-plugins configure iplookup\n Configure Sopel GeoIP Lookup Plugin\n Please consult sopel-iplookup's README to learn about its settings.\n\n Path to existing GeoIP db files (leave empty to auto download): \n MaxMind license key (optional): (hidden input)\n\nBy default, ``sopel-iplookup`` will look in a few standard locations for GeoIP\ndatabase files. If it can't find existing database files, it will download them\nfrom an automated mirror on GitHub.\n\nYou can optionally provide your own MaxMind license key, and the plugin will\ndownload directly from them instead. Alternatively, if your OS distribution\nalready has GeoIP database files kept up-to-date by the system package manager,\nyou can provide the path where those files are stored.\n\nNotes\n=====\n\nThis plugin replaces a built-in Sopel plugin formerly called ``ip``, you may need\nto update your bot configuration to replace ``ip`` with ``iplookup`` if you are e.g.\nexcluding this plugin.\n\nChangelog\n=========\n\n\n1.1.0\n-----\n\n* plugin, config: add config field for MaxMind license key (#4, #5)\n * If no MaxMind key is provided, the plugin will download from a mirror of\n the .mmdb files on GitHub. With a license key, the plugin downloads directly\n from MaxMind.\n* plugin: slightly better logging during/after DB downloads\n* meta: add automated release workflow using PyPI Trusted Publishing (#7)\n\n1.0.0\n-----\n\nInitial release. Replaces ``ip`` plugin formerly shipped as part of ``sopel``.\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "IP Lookup plugin for Sopel",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/sopel-irc/sopel-iplookup/issues",
"Homepage": "https://github.com/sopel-irc/sopel-iplookup"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "036cb5729eb97578364cecbec1e36d9d2a4f6f635de240ec137195b5ce4837a9",
"md5": "2ec520c4432aeb06d4c0ec9735addbcd",
"sha256": "ade6974c15aa895e849353e8a05fded2ec054caae462c15d43ead11ea5d33c9d"
},
"downloads": -1,
"filename": "sopel_iplookup-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ec520c4432aeb06d4c0ec9735addbcd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 7504,
"upload_time": "2024-06-20T02:20:22",
"upload_time_iso_8601": "2024-06-20T02:20:22.203558Z",
"url": "https://files.pythonhosted.org/packages/03/6c/b5729eb97578364cecbec1e36d9d2a4f6f635de240ec137195b5ce4837a9/sopel_iplookup-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "40d4515fe802850bf219e0952817ece3ae3fa9b7b3c69b324afd611869a1a062",
"md5": "88a66f6ff970635bf9bf0770994e1b58",
"sha256": "c3386999bb131d0d507e70151503a644a20ed658accb221c13c06b69f6865c8d"
},
"downloads": -1,
"filename": "sopel_iplookup-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "88a66f6ff970635bf9bf0770994e1b58",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 6828,
"upload_time": "2024-06-20T02:20:23",
"upload_time_iso_8601": "2024-06-20T02:20:23.151544Z",
"url": "https://files.pythonhosted.org/packages/40/d4/515fe802850bf219e0952817ece3ae3fa9b7b3c69b324afd611869a1a062/sopel_iplookup-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-20 02:20:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sopel-irc",
"github_project": "sopel-iplookup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "flake8",
"specs": []
},
{
"name": "pylint",
"specs": []
},
{
"name": "pyroma",
"specs": []
},
{
"name": "mypy",
"specs": []
},
{
"name": "types-pytz",
"specs": []
}
],
"lcname": "sopel-iplookup"
}
JSON
