Copy from PRAW

Author: PythonCoderAS

.gitignore

@@ -2,10 +2,10 @@
 *.egg-info/
 *.eggs/
 *.pyc
-*~
-.DS_Store
 .cache/
 .coverage
+.pytest_cache/
+.tox/
 _build/
 build/
 dist/

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Randall Goodman
+Copyright (c) 2020, PokestarFan
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.rst

@@ -18,26 +18,9 @@ Install prawdditions using ``pip`` via:
 
     pip install prawdditions
 
-
-Usage
------
-
-The following example demonstrates how to use prawdditions...
-
-.. code-block:: python
-
-   import praw
-   import prawdditions
-   
-   #Instantiate Reddit Client
-   reddit = praw.Reddit(...)
-   
-   #Abstract message function now available.
-   reddit.message('user_or_subreddit','subject','body')
-
 Contact
 -------
 
-Author: Randy Goodman
+Author: PokestarFan
 
-Email: [email protected]
+Please file a Github Issue if you have any problems.

prawdditions/__init__.py

@@ -1,63 +1 @@
-import json
-
-
-from praw import Reddit, const
-from praw.models.reddit.wikipage import WikiPage
-from prawcore.exceptions import Conflict
-
-
-def message(self, to, title, body, from_sr=None):
-    """Abstract function for sending out a message via string.
-
-    :param to: Destination of the message.
-    :param title: The subject line of the message.
-    :param body: The body of the message.
-    :param from_sr: A Subreddit instance of string to send the message from.
-        By default the message originates from the user.
-    :returns: The json response from the server.
-
-    example:
-
-    .. code-block:: python
-
-    reddit = praw.Reddit(client_id='CLIENT_ID',
-                         client_secret="CLIENT_SECRET", password='PASSWORD',
-                         user_agent='USERAGENT', username='USERNAME')
-    reddit.message('username','title','body')
-
-    """
-    data = {'subject': title,
-            'text': body,
-            'to': to}
-    if from_sr:
-        data['from_sr'] = str(from_sr)
-    return self.post(const.API_PATH['compose'], data=data)
-
-
-def update(self, transformation, reason=None):
-    """Safely update a page based on its current content.
-
-    :param transformation: A function taking the previous content as its
-        sole parameter and returning the new content.
-    :param reason: (Optional) The reason for the revision.
-
-    """
-    current_revision = next(self.revisions(limit=1))
-    revision_id = current_revision['id']
-    content = current_revision['page'].content_md
-    new_content = transformation(content)
-    while True:
-        try:
-            self.edit(new_content, reason=reason, previous=revision_id)
-            return
-        except Conflict as conflict:
-            response_body = json.loads(conflict.response.content.decode())
-            new_content = transformation(response_body['newcontent'])
-            revision_id = response_body['newrevision']
-
-"""
-Attach the message function to the Reddit object.
-Instantiations of the reddit object will now contain the message function.
-"""
-Reddit.message = message
-WikiPage.update = update
+"""Top level of the PRAWdittions package."""

prawdditions/const.py

@@ -1 +1,3 @@
-__version__ = '0.1.2'
+"""PRAWdittions constants."""
+
+__version__ = "0.2.0"

pre_push.py

@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+"""Run static analysis on the project."""
+
+import argparse
+import sys
+from os import path
+from subprocess import CalledProcessError, check_call
+
+current_directory = path.abspath(path.join(__file__, ".."))
+
+
+def do_process(args, shell=False):
+    """Run program provided by args.
+
+    Return True on success.
+
+    Output failed message on non-zero exit and return False.
+
+    Exit if command is not found.
+    """
+    print("Running: {}".format(" ".join(args)))
+    try:
+        check_call(args, shell=shell)
+    except CalledProcessError:
+        print("\nFailed: {}".format(" ".join(args)))
+        return False
+    except Exception as exc:
+        sys.stderr.write(str(exc) + "\n")
+        sys.exit(1)
+    return True
+
+
+def run_static():
+    """Runs the static tests.
+
+    Returns a statuscode of 0 if everything ran correctly.
+    Otherwise, it will return statuscode 1
+    """
+    success = True
+    success &= do_process(["black", "."])
+    success &= do_process(["flake8", "--exclude=.eggs,build,docs"])
+    success &= do_process(["pydocstyle", "prawdditions"])
+    return success
+
+
+def run_unit():
+    """Runs the unit-tests.
+
+    Follows the behavior of the static tests,
+    where any failed tests cause pre_push.py to fail.
+    """
+    return do_process([sys.executable, "pytest"])
+
+
+def main():
+    """Runs the main function.
+
+    usage: pre_push.py [-h] [-n] [-u] [-a]
+
+    Run static and/or unit-tests
+    """
+    parser = argparse.ArgumentParser(
+        description="Run static and/or unit-tests"
+    )
+    parser.add_argument(
+        "-n",
+        "--unstatic",
+        action="store_true",
+        help="Do not run static tests (black/flake8/pydocstyle/sphinx-build)",
+        default=False,
+    )
+    parser.add_argument(
+        "-u",
+        "--unit-tests",
+        "--unit",
+        action="store_true",
+        default=False,
+        help="Run the unit tests",
+    )
+    parser.add_argument(
+        "-a",
+        "--all",
+        action="store_true",
+        default=False,
+        help="Run all of the tests (static and unit). "
+        "Overrides the unstatic argument.",
+    )
+    args = parser.parse_args()
+    success = True
+    try:
+        if not args.unstatic or args.all:
+            success &= run_static()
+        if args.all or args.unit_tests:
+            success &= run_unit()
+    except KeyboardInterrupt:
+        return int(not False)
+    return int(not success)
+
+
+if __name__ == "__main__":
+    exit_code = main()
+    print(
+        "\npre_push.py: Success!" if not exit_code else "\npre_push.py: Fail"
+    )
+    sys.exit(exit_code)

pyproject.toml

@@ -0,0 +1,3 @@
+[tool.black]
+exclude = '/(\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|_build|buck-out|build|dist)/'
+line-length = 79

pytest.ini

@@ -1,2 +1,4 @@
 [pytest]
 testpaths = tests
+filterwarnings =
+    ignore::DeprecationWarning

setup.py

@@ -6,42 +6,56 @@
 from setuptools import find_packages, setup
 
 
-PACKAGE_NAME = 'prawdditions'
+PACKAGE_NAME = "prawdditions"
 HERE = path.abspath(path.dirname(__file__))
-with open(path.join(HERE, 'README.rst'), encoding='utf-8') as fp:
+with open(path.join(HERE, "README.rst"), encoding="utf-8") as fp:
     README = fp.read()
-with open(path.join(HERE, PACKAGE_NAME, 'const.py'),
-          encoding='utf-8') as fp:
+with open(path.join(HERE, PACKAGE_NAME, "const.py"), encoding="utf-8") as fp:
     VERSION = re.search("__version__ = '([^']+)'", fp.read()).group(1)
 
+extras = {
+    "ci": ["coveralls"],
+    "dev": ["pre-commit"],
+    "lint": ["black", "flake8", "pydocstyle", "sphinx", "sphinx_rtd_theme"],
+    "test": [
+        "betamax >=0.8, <0.9",
+        "betamax-matchers >=0.3.0, <0.5",
+        "betamax-serializers >=0.2, <0.3",
+        "mock >=0.8",
+        "pytest >=2.7.3",
+    ],
+}
 
-setup(name=PACKAGE_NAME,
-      author='Randall Goodman',
-      author_email='[email protected]',
-      classifiers=[
-          'Development Status :: 4 - Beta',
-          'Intended Audience :: Developers',
-          'License :: OSI Approved :: BSD License',
-          'Natural Language :: English',
-          'Programming Language :: Python',
-          'Programming Language :: Python :: 2.7',
-          'Programming Language :: Python :: 3',
-          'Programming Language :: Python :: 3.3',
-          'Programming Language :: Python :: 3.4',
-          'Programming Language :: Python :: 3.5',
-          'Programming Language :: Python :: Implementation :: CPython'],
-      description='DESCRIPTION.',
-      install_requires=['praw >=5.0.0, <7.0'],
-      keywords='praw additions',
-      license='Simplified BSD License',
-      long_description=README,
-      packages=find_packages(exclude=['tests', 'tests.*']),
-      setup_requires=['pytest-runner ==2.7'],
-      tests_require=['betamax >=0.8, <0.9',
-                     'betamax-matchers >=0.3.0, <0.4',
-                     'betamax-serializers >=0.2, <0.3',
-                     'mock ==1.0.1',
-                     'pytest ==2.8.7'],
-      test_suite='tests',
-      url='https://github.com/praw-dev/prawdditions',
-      version=VERSION)
+extras["dev"] += extras["lint"] + extras["test"]
+
+setup(
+    name=PACKAGE_NAME,
+    author="PokestarFan",
+    author_email="[email protected]",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: BSD License",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "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",
+        "Topic :: Utilities",
+    ],
+    description="High-level utilities for PRAW.",
+    extras_require=extras,
+    install_requires=["praw < 7.0"],
+    keywords="praw additions",
+    license="Simplified BSD License",
+    long_description=README,
+    packages=find_packages(exclude=["tests", "tests.*"]),
+    package_data={"": ["LICENSE.txt"]},
+    test_suite="tests",
+    url="https://github.com/praw-dev/prawdditions",
+    version=VERSION,
+)