From b8b8a4bf3618639968e8be379e85e2ff84f2307a Mon Sep 17 00:00:00 2001 From: LilSpazJoekp <15524072+LilSpazJoekp@users.noreply.github.com> Date: Tue, 14 Jul 2020 19:09:36 -0500 Subject: [PATCH] Update docs Signed-off-by: LilSpazJoekp <15524072+LilSpazJoekp@users.noreply.github.com> --- AUTHORS.rst | 7 ++++++- CHANGES.rst | 5 +++-- LICENSE.txt | 1 - MANIFEST.in | 2 +- README.rst | 35 +++++------------------------------ SECURITY.md | 6 +++--- setup.py | 7 +++---- 7 files changed, 21 insertions(+), 42 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 89d3be966..3b57f6b9f 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -18,6 +18,12 @@ Documentation Contributors +PRAW Author +=========== + +- Bryce Boe `@bboe `_ + + Logo Creator ============ @@ -48,7 +54,6 @@ Source Contributors - Elaina Martineau `@CrackedP0t `_ - Rob Curtis `@waab76 `_ - Pyprohly `@Pyprohly `_ -- LilSpazJoekp `@LilSpazJoekp `_ - Timendum `@timendum `_ - vaclav-2012 `@vaclav-2012 `_ - Jon Meager `@H4CKY54CK `_ diff --git a/CHANGES.rst b/CHANGES.rst index 945531d7f..759428965 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,5 +1,6 @@ Change Log ========== -For changes prior to version 7.0 please see: `PRAW changelog -`_ + +For changes in PRAW please see: `PRAW Changelog +`_ diff --git a/LICENSE.txt b/LICENSE.txt index 6592d8248..95f6eccd1 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,5 +1,4 @@ Copyright (c) 2020, Joel Payne -Copyright (c) 2016, Bryce Boe All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/MANIFEST.in b/MANIFEST.in index 82eba137b..3282d801d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include CHANGES.rst LICENSE.txt README.rst +include CHANGES.rst LICENSE.txt README.rst praw_license.txt include asyncpraw/praw.ini include "asyncpraw/images/PRAW logo.png" include docs/Makefile diff --git a/README.rst b/README.rst index 3334d42ff..3097f7f66 100644 --- a/README.rst +++ b/README.rst @@ -98,12 +98,12 @@ Async PRAW Discussion and Support For those new to Python, or would otherwise consider themselves a Python beginner, please consider asking questions on the `r/learnpython `_ subreddit. There are wonderful people -there who can help with general Python and simple PRAW related questions. +there who can help with general Python and simple Async PRAW related questions. -Otherwise, there are a few official places to ask questions about PRAW: +Otherwise, there are a few official places to ask questions about Async PRAW: `r/redditdev `_ is the best place on -Reddit to ask PRAW related questions. This subreddit is for all Reddit API +Reddit to ask Async PRAW related questions. This subreddit is for all Reddit API related discussion so please tag submissions with *[PRAW]*. Please perform a search on the subreddit first to see if anyone has similar questions. @@ -133,27 +133,6 @@ Async PRAW's documentation is located at https://asyncpraw.readthedocs.io/. History ------- -`August 2010 -`_: -Timothy Mellor created a github project called ``reddit_api``. - -`March 2011 -`_: -The Python package ``reddit`` was registered and uploaded to pypi. - -`December 2011 -`_: -Bryce Boe took over as maintainer of the ``reddit`` package. - -`June 2012 -`_: -Bryce renamed the project ``PRAW`` and the repository was relocated to the -newly created praw-dev organization on GitHub. - -`February 2016 -`_: -Bryce began work on PRAW4, a complete rewrite of PRAW. - `February 2019 `_: Joel forked PRAW and began work on Async PRAW, an asynchronous compatible version of PRAW. @@ -161,11 +140,7 @@ Joel forked PRAW and began work on Async PRAW, an asynchronous compatible versio License ------- -PRAW's source (v4.0.0+) is provided under the `Simplified BSD License -`_. +Async PRAW's source (v7.1.1+) is provided under the `Simplified BSD License +`_. * Copyright (c), 2020, Joel Payne -* Copyright (c), 2016, Bryce Boe - -Earlier versions of PRAW were released under `GPLv3 -`_. diff --git a/SECURITY.md b/SECURITY.md index 7d67c99c1..a8bda16bf 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,10 +2,10 @@ ## Supported Versions -The supported versions of PRAW include the previous major release. -This means that if PRAW is on 6.5.0, PRAW versions 5.0.0 and greater are supported. +The supported versions of Async PRAW include the previous major release. +This means that if Async PRAW is on 6.5.0, Async PRAW versions 5.0.0 and greater are supported. ## Reporting a Vulnerability -Contact Bryce Boe (bbzbryce@gmail.com) as soon as possible to address +Contact Joel Payne (lilspazjoekp@gmail.com) as soon as possible to address the vulnerability. diff --git a/setup.py b/setup.py index d0e14d0cb..f5c7de527 100644 --- a/setup.py +++ b/setup.py @@ -52,7 +52,7 @@ "Topic :: Utilities", ], description=( - "PRAW, an acronym for `Python Reddit API Wrapper`, is a " + "Async PRAW, an acronym for `Asynchronous Python Reddit API Wrapper`, is a " "python package that allows for simple access to " "reddit's API." ), @@ -60,12 +60,11 @@ install_requires=[ "asyncprawcore >=1.0.1, <2.0", "update_checker >=0.17", - "websockets >=8.1", ], - keywords="reddit api wrapper async", + keywords="reddit api wrapper async asynchronous praw", license="Simplified BSD License", long_description=README, - package_data={"": ["LICENSE.txt"], PACKAGE_NAME: ["*.ini", "images/*.jpg"]}, + package_data={"": ["LICENSE.txt", "praw_license.txt"], PACKAGE_NAME: ["*.ini", "images/*.jpg"]}, packages=find_packages(exclude=["tests", "tests.*", "tools", "tools.*"]), url="https://asyncpraw.readthedocs.org/", version=VERSION,