<p align="center">
<p align="center"><img width="238" height="135" src="https://pysimplegui.net/images/logos/psglogofull.svg"><p>
<h2 align="center">psgreddit</h2>
<h2 align="center">A PySimpleGUI Application</h2>
</p>
Search Your Favorite Reddit Subs
<p align="center"><img width="340" height="498" src="screenshot.png"><p>
## Features
* Integrates PySimpleGUI with PRAW API
* Provides stating point for custom Reddit user interface
* Search your favorite subreddits and their comments
## Installation
### Using PIP with PyPI
The latest official release of PySimpleGUI products can be found on PyPI. To pip install the demo applications from PyPI, use this command
#### If you use the command `python` on your computer to invoke Python (Windows):
`python -m pip install --upgrade psgreddit`
#### If you use the command `python3` on your computer to invoke Python (Linux, Mac):
`python3 -m pip install --upgrade psgreddit`
### Using PIP with GitHub
You can also pip install the PySimpleGUI Applications that are in the PySimpleGUI GitHub account. The GitHub versions have bug fixes and new programs/features that have not yet been released to PyPI. To directly pip install from that repo:
#### If you use the command `python` on your computer to invoke Python (Windows):
```bash
python -m pip install --upgrade https://github.com/PySimpleGUI/psgreddit/zipball/main
```
#### If you use the command `python3` on your computer to invoke Python (Linux, Mac):
```bash
python3 -m pip install --upgrade https://github.com/PySimpleGUI/psgreddit/zipball/main
```
## Usage
Once installed, launch psgreddit by typing the following in your command line:
`psgreddit`
## Requirements
To use the GUI you'll need to install PySimpleGUI (http://www.PySimpleGUI.org for instructions)
One of these will install it for you.
```
pip install PySimpleGUI
pip3 install PySimpleGUI
```
You will also need to install the PRAW package which provides the APIs for accessing Reddit
## PRAW Credentials
You must signup with Reddit to in order to get own Reddit API credentials.
To sign up go to - https://www.reddit.com/prefs/apps/
For security reasons, the credentials are not stored in the source code, but instead in a "settings file". The User Settings APIs were added to PySimpleGUI in Nov 2020 and are perfect for storing login credentials.
When you first start the program, it will figure out that you don't have any credentials defined and will show you this settings window:
<p align="center"><p>
You can also use the "Settings" button in the main window to bring up the settings window.
## Search History
The items you search for are stored in the settings file as well. This makes future searches easier as you can select the search term from a drop-down list instead of typing them in.
## Running
Once the packages are installed, you only need to run the single Python file found in this repository - `Reddit_Searcher.py`
When running on Windows, launching with `pythonw` instead of plain `python` will start the program without showing a console window.
## License & Copyright
Copyright 2023-2024 PySimpleSoft, Inc. and/or its licensors.
This is a free-to-use "Utility" and is licensed under the
PySimpleGUI License Agreement, a copy of which is included in the
license.txt file and also available at https://pysimplegui.com/eula.
Please see Section 1.2 of the license regarding the use of this Utility,
and see https://pysimplegui.com/faq for any questions.
## Contributing
We are happy to receive issues describing bug reports and feature
requests! If your bug report relates to a security vulnerability,
please do not file a public issue, and please instead reach out to us
at issues@PySimpleGUI.com.
We do not accept (and do not wish to receive) contributions of
user-created or third-party code, including patches, pull requests, or
code snippets incorporated into submitted issues. Please do not send
us any such code! Bug reports and feature requests should not include
any source code.
If you nonetheless submit any user-created or third-party code to us,
(1) you assign to us all rights and title in or relating to the code;
and (2) to the extent any such assignment is not fully effective, you
hereby grant to us a royalty-free, perpetual, irrevocable, worldwide,
unlimited, sublicensable, transferrable license under all intellectual
property rights embodied therein or relating thereto, to exploit the
code in any manner we choose, including to incorporate the code into
PySimpleGUI and to redistribute it under any terms at our discretion.
Raw data
{
"_id": null,
"home_page": "https://github.com/PySimpleGUI/psgreddit",
"name": "psgreddit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "GUI UI PySimpleGUI tkinter psgreddit reddit",
"author": "PySimpleSoft Inc.",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d1/e6/063aa2513a2675a304c03d6890488181841954e872849066a7c55715366a/psgreddit-5.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\r\n <p align=\"center\"><img width=\"238\" height=\"135\" src=\"https://pysimplegui.net/images/logos/psglogofull.svg\"><p>\r\n\r\n <h2 align=\"center\">psgreddit</h2>\r\n <h2 align=\"center\">A PySimpleGUI Application</h2>\r\n</p>\r\n\r\nSearch Your Favorite Reddit Subs\r\n\r\n\r\n\r\n\r\n\r\n<p align=\"center\"><img width=\"340\" height=\"498\" src=\"screenshot.png\"><p>\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n## Features\r\n\r\n* Integrates PySimpleGUI with PRAW API\r\n* Provides stating point for custom Reddit user interface\r\n* Search your favorite subreddits and their comments\r\n\r\n## Installation\r\n\r\n### Using PIP with PyPI\r\n\r\nThe latest official release of PySimpleGUI products can be found on PyPI. To pip install the demo applications from PyPI, use this command\r\n\r\n#### If you use the command `python` on your computer to invoke Python (Windows):\r\n\r\n`python -m pip install --upgrade psgreddit`\r\n\r\n#### If you use the command `python3` on your computer to invoke Python (Linux, Mac):\r\n\r\n`python3 -m pip install --upgrade psgreddit`\r\n\r\n### Using PIP with GitHub\r\n\r\nYou can also pip install the PySimpleGUI Applications that are in the PySimpleGUI GitHub account. The GitHub versions have bug fixes and new programs/features that have not yet been released to PyPI. To directly pip install from that repo:\r\n\r\n#### If you use the command `python` on your computer to invoke Python (Windows):\r\n\r\n```bash\r\npython -m pip install --upgrade https://github.com/PySimpleGUI/psgreddit/zipball/main\r\n```\r\n\r\n#### If you use the command `python3` on your computer to invoke Python (Linux, Mac):\r\n\r\n```bash\r\npython3 -m pip install --upgrade https://github.com/PySimpleGUI/psgreddit/zipball/main\r\n```\r\n\r\n\r\n\r\n\r\n## Usage\r\n\r\nOnce installed, launch psgreddit by typing the following in your command line:\r\n\r\n`psgreddit`\r\n\r\n## Requirements\r\n\r\nTo use the GUI you'll need to install PySimpleGUI (http://www.PySimpleGUI.org for instructions)\r\n\r\nOne of these will install it for you.\r\n```\r\npip install PySimpleGUI\r\npip3 install PySimpleGUI\r\n```\r\n\r\nYou will also need to install the PRAW package which provides the APIs for accessing Reddit\r\n\r\n## PRAW Credentials\r\n\r\nYou must signup with Reddit to in order to get own Reddit API credentials.\r\n\r\nTo sign up go to - https://www.reddit.com/prefs/apps/ \r\n\r\nFor security reasons, the credentials are not stored in the source code, but instead in a \"settings file\". The User Settings APIs were added to PySimpleGUI in Nov 2020 and are perfect for storing login credentials. \r\n \r\nWhen you first start the program, it will figure out that you don't have any credentials defined and will show you this settings window:\r\n \r\n<p align=\"center\"><p>\r\n\r\n\r\nYou can also use the \"Settings\" button in the main window to bring up the settings window. \r\n\r\n## Search History\r\n\r\nThe items you search for are stored in the settings file as well. This makes future searches easier as you can select the search term from a drop-down list instead of typing them in.\r\n\r\n\r\n## Running\r\n\r\nOnce the packages are installed, you only need to run the single Python file found in this repository - `Reddit_Searcher.py`\r\n\r\nWhen running on Windows, launching with `pythonw` instead of plain `python` will start the program without showing a console window.\r\n\r\n## License & Copyright\r\n\r\nCopyright 2023-2024 PySimpleSoft, Inc. and/or its licensors.\r\n\r\nThis is a free-to-use \"Utility\" and is licensed under the\r\nPySimpleGUI License Agreement, a copy of which is included in the\r\nlicense.txt file and also available at https://pysimplegui.com/eula.\r\n\r\nPlease see Section 1.2 of the license regarding the use of this Utility,\r\nand see https://pysimplegui.com/faq for any questions.\r\n\r\n\r\n## Contributing\r\n\r\nWe are happy to receive issues describing bug reports and feature\r\nrequests! If your bug report relates to a security vulnerability,\r\nplease do not file a public issue, and please instead reach out to us\r\nat issues@PySimpleGUI.com.\r\n\r\nWe do not accept (and do not wish to receive) contributions of\r\nuser-created or third-party code, including patches, pull requests, or\r\ncode snippets incorporated into submitted issues. Please do not send\r\nus any such code! Bug reports and feature requests should not include\r\nany source code.\r\n\r\nIf you nonetheless submit any user-created or third-party code to us,\r\n(1) you assign to us all rights and title in or relating to the code;\r\nand (2) to the extent any such assignment is not fully effective, you\r\nhereby grant to us a royalty-free, perpetual, irrevocable, worldwide,\r\nunlimited, sublicensable, transferrable license under all intellectual\r\nproperty rights embodied therein or relating thereto, to exploit the\r\ncode in any manner we choose, including to incorporate the code into\r\nPySimpleGUI and to redistribute it under any terms at our discretion.\r\n",
"bugtrack_url": null,
"license": "Free To Use But Restricted",
"summary": "A GUI app made with PySimpleGUI used to search through Reddit and Subreddits using praw module",
"version": "5.0.0",
"project_urls": {
"Homepage": "https://github.com/PySimpleGUI/psgreddit"
},
"split_keywords": [
"gui",
"ui",
"pysimplegui",
"tkinter",
"psgreddit",
"reddit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3849915913ab308b342a84988fa387495e77c977857b795888f07539468ac0dd",
"md5": "4c0a49ac2386270248dadb6a8fdc4ac1",
"sha256": "e9ecbab5f16d4239d21dddbdb841aa0c4fbeba20df8b2c1599a5c7e3eb41b519"
},
"downloads": -1,
"filename": "psgreddit-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c0a49ac2386270248dadb6a8fdc4ac1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 78608,
"upload_time": "2024-02-26T20:49:14",
"upload_time_iso_8601": "2024-02-26T20:49:14.488393Z",
"url": "https://files.pythonhosted.org/packages/38/49/915913ab308b342a84988fa387495e77c977857b795888f07539468ac0dd/psgreddit-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1e6063aa2513a2675a304c03d6890488181841954e872849066a7c55715366a",
"md5": "faf33afcb58a466eb857cdec032e65f5",
"sha256": "79deaae4215cad497eae37cd3573f310259797b2f8867900fc911ca0ba98d048"
},
"downloads": -1,
"filename": "psgreddit-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "faf33afcb58a466eb857cdec032e65f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 80339,
"upload_time": "2024-02-26T20:49:17",
"upload_time_iso_8601": "2024-02-26T20:49:17.100069Z",
"url": "https://files.pythonhosted.org/packages/d1/e6/063aa2513a2675a304c03d6890488181841954e872849066a7c55715366a/psgreddit-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 20:49:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PySimpleGUI",
"github_project": "psgreddit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "praw",
"specs": []
},
{
"name": "PySimpleGUI",
"specs": [
[
">=",
"5"
]
]
}
],
"lcname": "psgreddit"
}
JSON
