Convert plugin to entrypoint style; next release to be 'sopel-weather'

MANIFEST.in

@@ -1,7 +1,6 @@
 include NEWS
-include COPYING
-include README.md
-include *requirements.txt
+include README.rst
+include LICENSE
 
 recursive-include tests *
 recursive-exclude * __pycache__

README.rst

@@ -22,7 +22,7 @@ Published release
 ~~~~~~~~~~~~~~~~~
 .. code-block::
 
-    pip install sopel-modules.weather
+    pip install sopel-weather
 
 From source
 ~~~~~~~~~~~
@@ -47,7 +47,6 @@ However, if you want or need to configure this plugin manually, you will need to
     weather_api_key = WEATHER_API_KEY
 
 
-
 Usage
 =====
 
@@ -130,11 +129,12 @@ Python Requirements
 ~~~~~~~~~~~~~~~~~~~
 .. code-block::
 
+    pytz
     requests
     sopel
 
-.. |version| image:: https://img.shields.io/pypi/v/sopel-modules.weather.svg
-   :target: https://pypi.python.org/pypi/sopel-modules.weather
+.. |version| image:: https://img.shields.io/pypi/v/sopel-weather.svg
+   :target: https://pypi.python.org/pypi/sopel-weather
 .. |build| image:: https://github.com/sopel-irc/sopel-weather/actions/workflows/python-tests.yml/badge.svg?branch=master
    :target: https://github.com/sopel-irc/sopel-weather/actions/workflows/python-tests.yml
 .. |issues| image:: https://img.shields.io/github/issues/sopel-irc/sopel-weather.svg
@@ -143,5 +143,5 @@ Python Requirements
    :target: https://lgtm.com/projects/g/sopel-irc/sopel-weather/alerts/
 .. |coverage-status| image:: https://coveralls.io/repos/github/sopel-irc/sopel-weather/badge.svg?branch=master
    :target: https://coveralls.io/github/sopel-irc/sopel-weather?branch=master
-.. |license| image:: https://img.shields.io/pypi/l/sopel-modules.weather.svg
-   :target: https://github.com/sopel-irc/sopel-modules.weather/blob/master/COPYING
+.. |license| image:: https://img.shields.io/pypi/l/sopel-weather.svg
+   :target: https://github.com/sopel-irc/sopel-weather/blob/master/LICENSE

setup.cfg

@@ -0,0 +1,39 @@
+[metadata]
+name = sopel-weather
+version = 1.6.0
+description = A working re-implementation of the weather plugin for Sopel
+long_description = file: README.rst, NEWS
+long_description_content_type = text/x-rst; charset=UTF-8
+author = Rusty Bower
+author_email = [email protected]
+url = https://github.com/sopel-irc/sopel-weather
+license = MIT License
+classifiers =
+    Intended Audience :: Developers
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: MIT License
+    Topic :: Communications :: Chat :: Internet Relay Chat
+
+[options]
+packages = find:
+zip_safe = false
+include_package_data = true
+test_suite = tests
+install_requires =
+    sopel>=7.1
+    requests
+    pytz
+tests_require =
+    codeclimate-test-reporter
+    coveralls
+    flake8
+    mock
+    pycodestyle
+    pytest>=3.6
+    pytest-cov
+    requests_mock
+    sopel
+
+[options.entry_points]
+sopel.plugins =
+    weather = sopel_weather

setup.py

@@ -1,44 +1,13 @@
 # -*- coding: utf-8 -*-
 from __future__ import print_function
-import os
 import sys
-from setuptools import setup, find_packages
+from setuptools import setup
 
 
 if __name__ == '__main__':
     print('Sopel does not correctly load modules installed with setup.py '
-          'directly. Please use "pip install .", or add {}/sopel_modules to '
-          'core.extra in your config.'.format(
-              os.path.dirname(os.path.abspath(__file__))),
+          'directly. Please use "pip install .".',
           file=sys.stderr)
 
-with open('README.rst') as readme_file:
-    readme = readme_file.read()
 
-with open('NEWS') as history_file:
-    history = history_file.read()
-
-with open('requirements.txt') as requirements_file:
-    requirements = [req for req in requirements_file.readlines()]
-
-with open('tests/requirements.txt') as dev_requirements_file:
-    dev_requirements = [req for req in dev_requirements_file.readlines()]
-
-
-setup(
-    name='sopel_modules.weather',
-    version='1.6.0',
-    description='A working re-implementation of the weather module for Sopel',
-    long_description=readme + '\n\n' + history,
-    long_description_content_type='text/x-rst',
-    author='Rusty Bower',
-    author_email='[email protected]',
-    url='http://github.com/rustybower/sopel-weather',
-    packages=find_packages('.'),
-    namespace_packages=['sopel_modules'],
-    include_package_data=True,
-    install_requires=requirements,
-    tests_require=dev_requirements,
-    test_suite='tests',
-    license='MIT License',
-)
+setup()

sopel_modules/weather/weather.py → sopel_weather/__init__.py

@@ -1,4 +1,8 @@
 # coding=utf-8
+"""sopel-weather
+
+A working re-implementation of the weather plugin for Sopel
+"""
 # Copyright 2008, Sean B. Palmer, inamidst.com
 # Copyright 2012, Elsie Powell, embolalia.com
 # Copyright 2018, Rusty Bower, rustybower.com

tests/test_weather.py

@@ -9,9 +9,9 @@
 from sopel.trigger import PreTrigger, Trigger
 from sopel.test_tools import MockSopel, MockSopelWrapper
 from sopel.tools import Identifier
-from sopel import module
+from sopel import plugin
 
-from sopel_modules.weather import weather
+import sopel_weather as weather
 
 
 @pytest.fixture
@@ -26,7 +26,7 @@ def bot(sopel, pretrigger):
     bot = MockSopelWrapper(sopel, pretrigger)
     bot.privileges = dict()
     bot.privileges[Identifier('#Sopel')] = dict()
-    bot.privileges[Identifier('#Sopel')][Identifier('Foo')] = module.VOICE
+    bot.privileges[Identifier('#Sopel')][Identifier('Foo')] = plugin.VOICE
     return bot
 
 
@@ -125,26 +125,26 @@ def forecast_results():
 
 
 def test_forecast_command(bot, trigger):
-    @module.commands('forecast')
-    @module.example('.forecast', 'True')
+    @plugin.commands('forecast')
+    @plugin.example('.forecast', 'True')
     def mock(bot, trigger, match=None):
         return True
 
     assert mock(bot, trigger) is True
 
 
 def test_wea_command(bot, trigger):
-    @module.commands('wea')
-    @module.example('.wea', 'True')
+    @plugin.commands('wea')
+    @plugin.example('.wea', 'True')
     def mock(bot, trigger, match=None):
         return True
 
     assert mock(bot, trigger) is True
 
 
 def test_weather_command(bot, trigger):
-    @module.commands('weather')
-    @module.example('.weather', 'True')
+    @plugin.commands('weather')
+    @plugin.example('.weather', 'True')
     def mock(bot, trigger, match=None):
         return True