Skip to content

Commit b8b8a4b

Browse files
committed
Update docs
Signed-off-by: LilSpazJoekp <15524072+LilSpazJoekp@users.noreply.github.com>
1 parent 8408d68 commit b8b8a4b

File tree

7 files changed

+21
-42
lines changed

7 files changed

+21
-42
lines changed

AUTHORS.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ Documentation Contributors
1818
<!-- - Add "Name <email (optional)> and github profile link" above this line. -->
1919

2020

21+
PRAW Author
22+
===========
23+
24+
- Bryce Boe <bbzbryce@gmail.com> `@bboe <https://github.com/bboe>`_
25+
26+
2127
Logo Creator
2228
============
2329

@@ -48,7 +54,6 @@ Source Contributors
4854
- Elaina Martineau `@CrackedP0t <https://github.com/CrackedP0t>`_
4955
- Rob Curtis <BourbonInExile@gmail.com> `@waab76 <https://github.com/waab76>`_
5056
- Pyprohly <pyprohly@outlook.com> `@Pyprohly <https://github.com/Pyprohly>`_
51-
- LilSpazJoekp `@LilSpazJoekp <https://github.com/LilSpazJoekp>`_
5257
- Timendum `@timendum <https://github.com/timendum>`_
5358
- vaclav-2012 `@vaclav-2012 <https://github.com/vaclav-2012>`_
5459
- Jon Meager `@H4CKY54CK <https://github.com/H4CKY54CK>`_

CHANGES.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Change Log
22
==========
33

4-
For changes prior to version 7.0 please see: `PRAW changelog
5-
<http://praw.readthedocs.io/en/latest/pages/changelog.html>`_
4+
5+
For changes in PRAW please see: `PRAW Changelog
6+
<https://praw.readthedocs.io/en/latest/pages/changelog.html>`_

LICENSE.txt

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
Copyright (c) 2020, Joel Payne
2-
Copyright (c) 2016, Bryce Boe
32
All rights reserved.
43

54
Redistribution and use in source and binary forms, with or without

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
include CHANGES.rst LICENSE.txt README.rst
1+
include CHANGES.rst LICENSE.txt README.rst praw_license.txt
22
include asyncpraw/praw.ini
33
include "asyncpraw/images/PRAW logo.png"
44
include docs/Makefile

README.rst

+5-30
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,12 @@ Async PRAW Discussion and Support
9898
For those new to Python, or would otherwise consider themselves a Python
9999
beginner, please consider asking questions on the `r/learnpython
100100
<https://www.reddit.com/r/learnpython>`_ subreddit. There are wonderful people
101-
there who can help with general Python and simple PRAW related questions.
101+
there who can help with general Python and simple Async PRAW related questions.
102102

103-
Otherwise, there are a few official places to ask questions about PRAW:
103+
Otherwise, there are a few official places to ask questions about Async PRAW:
104104

105105
`r/redditdev <https://www.reddit.com/r/redditdev>`_ is the best place on
106-
Reddit to ask PRAW related questions. This subreddit is for all Reddit API
106+
Reddit to ask Async PRAW related questions. This subreddit is for all Reddit API
107107
related discussion so please tag submissions with *[PRAW]*. Please perform a
108108
search on the subreddit first to see if anyone has similar questions.
109109

@@ -133,39 +133,14 @@ Async PRAW's documentation is located at https://asyncpraw.readthedocs.io/.
133133
History
134134
-------
135135

136-
`August 2010
137-
<https://github.com/praw-dev/praw/commit/efef08a4a713fcfd7dfddf992097cf89426586ae>`_:
138-
Timothy Mellor created a github project called ``reddit_api``.
139-
140-
`March 2011
141-
<https://github.com/praw-dev/praw/commit/ebfc9caba5b58b9e68c77af9c8e53f5562a2ee64>`_:
142-
The Python package ``reddit`` was registered and uploaded to pypi.
143-
144-
`December 2011
145-
<https://github.com/praw-dev/praw/commit/74bb962b3eefe04ce6acad88e6f53f43d10c8803>`_:
146-
Bryce Boe took over as maintainer of the ``reddit`` package.
147-
148-
`June 2012
149-
<https://github.com/praw-dev/praw/commit/adaf89fe8631f41ab9913b379de104c9ef6a1e73>`_:
150-
Bryce renamed the project ``PRAW`` and the repository was relocated to the
151-
newly created praw-dev organization on GitHub.
152-
153-
`February 2016
154-
<https://github.com/praw-dev/praw/commit/252083ef1dbfe6ea53c2dc99ac235b4ba330b658>`_:
155-
Bryce began work on PRAW4, a complete rewrite of PRAW.
156-
157136
`February 2019
158137
<https://github.com/praw-dev/asyncpraw/commit/55480eb3d59dc7bc3d1480d83b98c95effc77181>`_:
159138
Joel forked PRAW and began work on Async PRAW, an asynchronous compatible version of PRAW.
160139

161140
License
162141
-------
163142

164-
PRAW's source (v4.0.0+) is provided under the `Simplified BSD License
165-
<https://github.com/praw-dev/praw/blob/0860c11a9309c80621c267af7caeb6a993933744/LICENSE.txt>`_.
143+
Async PRAW's source (v7.1.1+) is provided under the `Simplified BSD License
144+
<https://github.com/praw-dev/asyncpraw/blob/30796acc29b4ba2335cf0eab414477702c29452f/LICENSE.txt>`_.
166145

167146
* Copyright (c), 2020, Joel Payne
168-
* Copyright (c), 2016, Bryce Boe
169-
170-
Earlier versions of PRAW were released under `GPLv3
171-
<https://github.com/praw-dev/praw/blob/0c88697fdc26e75f87b68e2feb11e101e90ce215/COPYING>`_.

SECURITY.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## Supported Versions
44

5-
The supported versions of PRAW include the previous major release.
6-
This means that if PRAW is on 6.5.0, PRAW versions 5.0.0 and greater are supported.
5+
The supported versions of Async PRAW include the previous major release.
6+
This means that if Async PRAW is on 6.5.0, Async PRAW versions 5.0.0 and greater are supported.
77

88
## Reporting a Vulnerability
99

10-
Contact Bryce Boe (bbzbryce@gmail.com) as soon as possible to address
10+
Contact Joel Payne (lilspazjoekp@gmail.com) as soon as possible to address
1111
the vulnerability.

setup.py

+3-4
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,19 @@
5252
"Topic :: Utilities",
5353
],
5454
description=(
55-
"PRAW, an acronym for `Python Reddit API Wrapper`, is a "
55+
"Async PRAW, an acronym for `Asynchronous Python Reddit API Wrapper`, is a "
5656
"python package that allows for simple access to "
5757
"reddit's API."
5858
),
5959
extras_require=extras,
6060
install_requires=[
6161
"asyncprawcore >=1.0.1, <2.0",
6262
"update_checker >=0.17",
63-
"websockets >=8.1",
6463
],
65-
keywords="reddit api wrapper async",
64+
keywords="reddit api wrapper async asynchronous praw",
6665
license="Simplified BSD License",
6766
long_description=README,
68-
package_data={"": ["LICENSE.txt"], PACKAGE_NAME: ["*.ini", "images/*.jpg"]},
67+
package_data={"": ["LICENSE.txt", "praw_license.txt"], PACKAGE_NAME: ["*.ini", "images/*.jpg"]},
6968
packages=find_packages(exclude=["tests", "tests.*", "tools", "tools.*"]),
7069
url="https://asyncpraw.readthedocs.org/",
7170
version=VERSION,

0 commit comments

Comments
 (0)