Work toward 1.0

.circleci/config.yml

@@ -9,8 +9,9 @@ jobs:
           name: Run Tests
           command: |
             apt-get update && apt-get -y --no-install-recommends install rabbitmq-server
-            service rabbitmq-server start
-            python setup.py test
+            pip install 'pytest~=6.2' 'pytest-cov~=2.7' 'mock~=2.0' 'pika>=0.13' 'redis>=3.4'
+            pip install -e .
+            pytest
 workflows:
   version: 2
   commit:

CHANGES.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+Version 1.0
+-----------
+
+- Removed the `RabbitmqBroker.publish_message()` method.
+
+- Documented the use of `missing` configuration values.
+
+
 Version 0.3.9
 -------------
 

docs/api.rst

@@ -9,10 +9,12 @@ API Reference
    :members: init_app, set_default, actor
 
 .. autoclass:: RabbitmqBroker
-   :members: init_app, set_default, actor, publish_message
+   :members: init_app, set_default, actor
 
 .. autoclass:: RedisBroker
    :members: init_app, set_default, actor
 
 .. autoclass:: StubBroker
    :members: init_app, set_default, actor
+
+.. autoclass:: missing

docs/conf.py

@@ -62,16 +62,16 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.9'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.9'
+release = '1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -138,7 +138,7 @@
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = 'Flask-Melodramatiq v0.3.9'
+# html_title = 'Flask-Melodramatiq v1.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #

flask_melodramatiq/__init__.py

@@ -9,7 +9,6 @@
     Broker,
     missing,
 )
-from flask_melodramatiq.rabbitmq import RabbitmqBrokerMixin
 
 __all__ = ['create_broker_class', 'Broker', 'RabbitmqBroker', 'RedisBroker', 'StubBroker']
 
@@ -77,7 +76,6 @@ def raise_error(e, *args, **kwargs):
     docstring=LAZY_BROKER_DOCSTRING_TEMPLATE.format(
         description='A lazy broker wrapping a :class:`~dramatiq.brokers.rabbitmq.RabbitmqBroker`.\n',
     ),
-    mixins=(RabbitmqBrokerMixin,)
 )
 
 

flask_melodramatiq/lazy_broker.py

@@ -8,7 +8,18 @@
 
 
 class missing:
-    """Missing value for configuration variables."""
+    """Missing value for configuration variables. This can be useful when
+    you want to document the given configuration setting in your code,
+    but you do not want to change the default value.
+
+    For example::
+
+        from flask import Flask
+        from flask_melodramatiq import missing
+
+        app = Flask(__name__)
+        app.config['DRAMATIQ_BROKER_URL'] = missing
+    """
 
 
 DEFAULT_CLASS_NAME = 'RabbitmqBroker'

setup.py

@@ -22,7 +22,7 @@ def rel(*xs):
 
 setup(
     name='Flask-Melodramatiq',
-    version='0.3.9',
+    version='1.0',
     url='https://github.com/epandurski/flask_melodramatiq',
     license='MIT',
     author='Evgeni Pandurski',
@@ -54,9 +54,10 @@ def rel(*xs):
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
     ],
     project_urls={
         "Bug Tracker": "https://github.com/epandurski/flask_melodramatiq/issues",