{ "info": { "author": "aav-bots", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6" ], "description": "upcoming-games\n==============\n\nReddit bot to update sidebar for /r/IGN. Can be configured for a variety\nof uses.\n\nUsage\n=====\n\n1. Install Python 3.6 or greater if you have not already.\n2. Install the bot with ``pip install aav.upcoming-games``. You may need\n to use ``sudo`` or ``pip3`` or ``--user`` depending on your\n permissions, i.e.\u00a0if you do not have sudo permissions and you also\n have Python 2 installed, you may need to use\n ``pip3 install --user aav.upcoming-games``.\n3. Obtain a Reddit client ID and client secret from\n https://reddit.com/prefs/apps on the account you want to use for the\n bot.\n4. Set up your configuration file and template as mentioned in the\n \u2018Configuration\u2019 section.\n5. Run the bot from the command line with the full path to your config\n file: ``upcoming-games \"/home/aav/my.yaml\"``\n\nDeveloper Usage\n===============\n\n1. Install Python 3.6 or greater if you have not already.\n2. Install the bot with ``pip install aav.upcoming-games``. You may need\n to use ``sudo`` or ``pip3`` or ``--user`` depending on your\n permissions, i.e.\u00a0if you do not have sudo permissions and you also\n have Python 2 installed, you may need to use\n ``pip3 install --user aav.upcoming-games``.\n3. ``import upcoming_games``\n4. You can use any of the three functions: ``get_all_games``,\n ``get_markdown``, ``post_table``, and the class ``UpcomingGame`` as\n desired.\n\nConfiguration\n=============\n\nHere is the default configuration file:\n\n.. code:: yaml\n\n general:\n silent: False\n time_period: \"7d\"\n systems: []\n game_limit: 10\n table_format: \"short\"\n\n reddit:\n client_id: \"...\"\n client_secret: \"...\"\n subreddit: \"...\"\n scripthost: \"...\"\n password: \"...\"\n post_type: \"sidebar\"\n template: 'path/to/template.txt'\n\nHere\u2019s what each setting is for:\n\n- ``general``\n\n - ``silent`` - True if you don\u2019t want any script output.\n - ``time_period`` - Valid time period for upcoming games (can be one\n of ``7d, 1m, 3m, 6m, 12m, all``).\n - ``system`` - List of consoles you want to include releases for.\n Empty means include all.\n - ``game_limit`` - Number of games you want for the Markdown table.\n - ``table_format`` - ``short`` for only the game name and first\n release, ``long`` for system details.\n\n- ``reddit``\n\n - ``client_id`` - Your reddit bot\u2019s client ID.\n - ``client_secret`` - Your reddit bot\u2019s client secret.\n - ``subreddit`` - The subreddit (your must be a moderator) to post\n to/update the sidebar.\n - ``scripthost`` - The username for the bot account you registered\n for the client ID on.\n - ``password`` - The password for the bot account.\n - ``post_type`` - ``sidebar`` to update the sidebar, ``sticky`` to\n make a \u2018bottom\u2019 stickied post.\n - ``template`` - the full path to the template you want to use.\n\nNote the template must contain somewhere in it the text %%%TABLE%%%, as\nthis is where the Markdown table will be put. If no path or an invalid\npath is specified, the template used will be blank, i.e.\u00a0it will only\ncontain the Markdown table, nothing else.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/aav-bots/upcoming-games", "keywords": "aav upcoming games reddit bot", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "aav.upcoming-games", "package_url": "https://pypi.org/project/aav.upcoming-games/", "platform": "", "project_url": "https://pypi.org/project/aav.upcoming-games/", "project_urls": { "Homepage": "https://github.com/aav-bots/upcoming-games" }, "release_url": "https://pypi.org/project/aav.upcoming-games/0.1.0/", "requires_dist": [ "praw", "requests", "ruamel.yaml", "parsedatetime", "beautifulsoup4" ], "requires_python": ">=3.6", "summary": "Reddit bot to provide updates for video games.", "version": "0.1.0" }, "last_serial": 3504847, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "55bfeb740345c12dae0a15712cdd483d", "sha256": "5dd0d8ecaf5269c8a877201c0056d9886c12b770ff86ce71c0afa1c45a4bb7ef" }, "downloads": -1, "filename": "aav.upcoming_games-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "55bfeb740345c12dae0a15712cdd483d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7622, "upload_time": "2018-01-19T15:57:00", "url": "https://files.pythonhosted.org/packages/58/78/afc4cdffa533d3bd1d26df64e6dcf0ab17d96f4c1090f84ba10de9eafda6/aav.upcoming_games-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bc0e8902378e34bde77a6f7e4a57ccd6", "sha256": "32f85f92a70e9a9f6543b2c465d594c8ec703e6bf43f3f110f9c5583548376c3" }, "downloads": -1, "filename": "aav.upcoming-games-0.1.0.tar.gz", "has_sig": false, "md5_digest": "bc0e8902378e34bde77a6f7e4a57ccd6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4789, "upload_time": "2018-01-19T15:57:01", "url": "https://files.pythonhosted.org/packages/78/b3/21b134c7692f08518808b6d00356094d3ffa1d707fe6a8909cc4a0387b09/aav.upcoming-games-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "55bfeb740345c12dae0a15712cdd483d", "sha256": "5dd0d8ecaf5269c8a877201c0056d9886c12b770ff86ce71c0afa1c45a4bb7ef" }, "downloads": -1, "filename": "aav.upcoming_games-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "55bfeb740345c12dae0a15712cdd483d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 7622, "upload_time": "2018-01-19T15:57:00", "url": "https://files.pythonhosted.org/packages/58/78/afc4cdffa533d3bd1d26df64e6dcf0ab17d96f4c1090f84ba10de9eafda6/aav.upcoming_games-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bc0e8902378e34bde77a6f7e4a57ccd6", "sha256": "32f85f92a70e9a9f6543b2c465d594c8ec703e6bf43f3f110f9c5583548376c3" }, "downloads": -1, "filename": "aav.upcoming-games-0.1.0.tar.gz", "has_sig": false, "md5_digest": "bc0e8902378e34bde77a6f7e4a57ccd6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4789, "upload_time": "2018-01-19T15:57:01", "url": "https://files.pythonhosted.org/packages/78/b3/21b134c7692f08518808b6d00356094d3ffa1d707fe6a8909cc4a0387b09/aav.upcoming-games-0.1.0.tar.gz" } ] }