Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: LilSpazJoekp <15524072+LilSpazJoekp@users.noreply.github.com>
  • Loading branch information
LilSpazJoekp committed Jul 15, 2020
1 parent 8408d68 commit b8b8a4b
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 42 deletions.
7 changes: 6 additions & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ Documentation Contributors
<!-- - Add "Name <email (optional)> and github profile link" above this line. -->


PRAW Author
===========

- Bryce Boe <bbzbryce@gmail.com> `@bboe <https://github.com/bboe>`_


Logo Creator
============

Expand Down Expand Up @@ -48,7 +54,6 @@ Source Contributors
- Elaina Martineau `@CrackedP0t <https://github.com/CrackedP0t>`_
- Rob Curtis <BourbonInExile@gmail.com> `@waab76 <https://github.com/waab76>`_
- Pyprohly <pyprohly@outlook.com> `@Pyprohly <https://github.com/Pyprohly>`_
- LilSpazJoekp `@LilSpazJoekp <https://github.com/LilSpazJoekp>`_
- Timendum `@timendum <https://github.com/timendum>`_
- vaclav-2012 `@vaclav-2012 <https://github.com/vaclav-2012>`_
- Jon Meager `@H4CKY54CK <https://github.com/H4CKY54CK>`_
Expand Down
5 changes: 3 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Change Log
==========

For changes prior to version 7.0 please see: `PRAW changelog
<http://praw.readthedocs.io/en/latest/pages/changelog.html>`_

For changes in PRAW please see: `PRAW Changelog
<https://praw.readthedocs.io/en/latest/pages/changelog.html>`_
1 change: 0 additions & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -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
Expand Down
35 changes: 5 additions & 30 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://www.reddit.com/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 <https://www.reddit.com/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.

Expand Down Expand Up @@ -133,39 +133,14 @@ Async PRAW's documentation is located at https://asyncpraw.readthedocs.io/.
History
-------

`August 2010
<https://github.com/praw-dev/praw/commit/efef08a4a713fcfd7dfddf992097cf89426586ae>`_:
Timothy Mellor created a github project called ``reddit_api``.

`March 2011
<https://github.com/praw-dev/praw/commit/ebfc9caba5b58b9e68c77af9c8e53f5562a2ee64>`_:
The Python package ``reddit`` was registered and uploaded to pypi.

`December 2011
<https://github.com/praw-dev/praw/commit/74bb962b3eefe04ce6acad88e6f53f43d10c8803>`_:
Bryce Boe took over as maintainer of the ``reddit`` package.

`June 2012
<https://github.com/praw-dev/praw/commit/adaf89fe8631f41ab9913b379de104c9ef6a1e73>`_:
Bryce renamed the project ``PRAW`` and the repository was relocated to the
newly created praw-dev organization on GitHub.

`February 2016
<https://github.com/praw-dev/praw/commit/252083ef1dbfe6ea53c2dc99ac235b4ba330b658>`_:
Bryce began work on PRAW4, a complete rewrite of PRAW.

`February 2019
<https://github.com/praw-dev/asyncpraw/commit/55480eb3d59dc7bc3d1480d83b98c95effc77181>`_:
Joel forked PRAW and began work on Async PRAW, an asynchronous compatible version of PRAW.

License
-------

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

* Copyright (c), 2020, Joel Payne
* Copyright (c), 2016, Bryce Boe

Earlier versions of PRAW were released under `GPLv3
<https://github.com/praw-dev/praw/blob/0c88697fdc26e75f87b68e2feb11e101e90ce215/COPYING>`_.
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
7 changes: 3 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,20 +52,19 @@
"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."
),
extras_require=extras,
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,
Expand Down

0 comments on commit b8b8a4b

Please sign in to comment.