diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b283b2e6..d127c990 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,48 +1,7 @@ -# Contributing to PlexPy - -## Issues -In case you read this because you are posting an issue, please take a minute and conside the things below. The issue tracker is not a support forum. It is primarily intended to submit bugs. However, we are glad to help you, and make sure the problem is not caused by PlexPy, but don't expect step-by-step answers. - -##### Many issues can simply be solved by: - -- Making sure you update to the latest version. -- Turning your device off and on again. -- Analyzing your logs, you just might find the solution yourself! -- Using the **search** function to see if this issue has already been reported/solved. -- Checking the [Wiki](https://github.com/JonnyWong16/plexpy/wiki) for -[ [Installation] ](https://github.com/JonnyWong16/plexpy/wiki/Installation) and -[ [FAQs] ](https://github.com/JonnyWong16/plexpy/wiki/Frequently-Asked-Questions-(FAQ)). -- For basic questions try asking on [Gitter](https://gitter.im/plexpy/general) or the [Plex Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) first before opening an issue. - -##### If nothing has worked: - -1. Open a new issue on the GitHub [issue tracker](http://github.com/JonnyWong16/plexpy/issues). -2. Provide a clear title to easily help identify your problem. -3. Use proper [markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post (i.e. code/log in code blocks). -4. Make sure you provide the following information: - - [ ] Version - - [ ] Branch - - [ ] Commit hash - - [ ] Operating system - - [ ] Python version - - [ ] What you did? - - [ ] What happened? - - [ ] What you expected? - - [ ] How can we reproduce your issue? - - [ ] What are your (relevant) settings? - - [ ] Include a link to your **FULL** (not just a few lines!) log file that has the error. Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/). -5. Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. - -## Feature Requests - -Feature requests are handled on [FeatHub](http://feathub.com/JonnyWong16/plexpy). - -1. Search the existing requests to see if your suggestion has already been submitted. -2. If a similar request exists, give it a thumbs up (+1), or add additional comments to the request. -3. If no similar requests exist, you can create a new one. Make sure to provide a clear title to easily identify the feature request. +# Contributing to Tautulli ## Pull Requests -If you think you can contribute code to the PlexPy repository, do not hesitate to submit a pull request. +If you think you can contribute code to the Tautulli repository, do not hesitate to submit a pull request. ### Branches All pull requests should be based on the `dev` branch, to minimize cross merges. When you want to develop a new feature, clone the repository with `git clone origin/dev -b FEATURE_NAME`. Use meaningful commit messages. @@ -50,12 +9,12 @@ All pull requests should be based on the `dev` branch, to minimize cross merges. ### Python Code #### Compatibility -The code should work with Python 2.6 and 2.7. Note that PlexPy runs on different platforms, including Network Attached Storage devices such as Synology. +The code should work with Python 2.7. Note that Tautulli runs on different platforms, including Network Attached Storage devices such as Synology. Re-use existing code. Do not hesitate to add logging in your code. You can the logger module `plexpy.logger.*` for this. Web requests are invoked via `plexpy.request.*` and derived ones. Use these methods to automatically add proper and meaningful error handling. #### Code conventions -Although PlexPy did not adapt a code convention in the past, we try to follow the [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conventions for future code. A short summary to remind you (copied from http://wiki.ros.org/PyStyleGuide): +Although Tautulli did not adapt a code convention in the past, we try to follow the [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conventions for future code. A short summary to remind you (copied from http://wiki.ros.org/PyStyleGuide): * 4 space indentation * 80 characters per line @@ -71,12 +30,12 @@ Although PlexPy did not adapt a code convention in the past, we try to follow th Document your code. Use docstrings See [PEP-257](https://www.python.org/dev/peps/pep-0257/) for more information. #### Continuous Integration -PlexPy has a configuration file for [travis-ci](https://travis-ci.org/). You can add your forked repo to Travis to have it check your code against PEP8, PyLint, and PyFlakes for you. Your pull request will show a green check mark or a red cross on each tested commit, depending on if linting passes. +Tautulli has a configuration file for [travis-ci](https://travis-ci.org/). You can add your forked repo to Travis to have it check your code against PEP8, PyLint, and PyFlakes for you. Your pull request will show a green check mark or a red cross on each tested commit, depending on if linting passes. ### HTML/Template code #### Compatibility -HTML5 compatible browsers are targetted. There is no specific mobile version of PlexPy yet. +HTML5 compatible browsers are targetted. There is no specific mobile version of Tautulli yet. #### Conventions * 4 space indentation diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 1ac80899..a1632d9a 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -8,7 +8,7 @@ Reporting Issues: Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/). Feature Requests: - * Feature requests are handled on FeatHub: http://feathub.com/JonnyWong16/plexpy + * Feature requests are handled on FeatHub: http://feathub.com/Tautulli/Tautulli * Do not post them on the GitHub issues tracker. --> diff --git a/README.md b/README.md index ad60878c..cb25b87d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Discord](https://img.shields.io/badge/Discord-Tautulli-7289DA.svg?style=flat-square)](https://discord.gg/tQcWEUp) [![Reddit](https://img.shields.io/badge/Reddit-Tautulli-FF5700.svg?style=flat-square)](https://www.reddit.com/r/Tautulli/) -[![Plex Forums](https://img.shields.io/badge/Plex%20Forums-Tautulli-E5A00D.svg?style=flat-square)](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) +[![Plex Forums](https://img.shields.io/badge/Plex%20Forums-Tautulli-E5A00D.svg?style=flat-square)](https://forums.plex.tv/discussion/307821/tautulli-monitor-your-plex-media-server) A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv). @@ -27,56 +27,19 @@ This project is based on code from [Headphones](https://github.com/rembo10/headp ## Preview -* [Full preview gallery on our website](http://tautulli.com) +* [Full preview gallery available on our website](http://tautulli.com) ![Tautulli Homepage](http://tautulli.com/images/screenshots/activity-compressed.jpg?v=2) ## Installation and Support -* [Installation Guides](https://github.com/JonnyWong16/plexpy/wiki/Installation) shows you how to install Tautulli. -* [FAQs](https://github.com/JonnyWong16/plexpy/wiki/Frequently-Asked-Questions-(FAQ)) in the wiki can help you with common problems. +* Read the [Installation Guides](https://github.com/Tautulli/Tautulli-Wiki/wiki/Installation) for instructions to install Tautulli. +* The [Frequently Asked Questions](https://github.com/Tautulli/Tautulli-Wiki/wiki/Frequently-Asked-Questions) in the wiki can help you with common problems. +* Support is available on [Discord](https://discord.gg/tQcWEUp), [Reddit](https://www.reddit.com/r/Tautulli), or the [Plex Forums](https://forums.plex.tv/discussion/307821/tautulli-monitor-your-plex-media-server). -**Support** the project by implementing new features, solving support tickets and provide bug fixes. +## Issues & Feature Requests -## Issues - -##### Many issues can simply be solved by: - -- Making sure you update to the latest version. -- Turning your device off and on again. -- Analyzing your logs, you just might find the solution yourself! -- Using the **search** function to see if this issue has already been reported/solved. -- Checking the [Wiki](https://github.com/JonnyWong16/plexpy/wiki) for -[ [Installation] ](https://github.com/JonnyWong16/plexpy/wiki/Installation) and -[ [FAQs] ](https://github.com/JonnyWong16/plexpy/wiki/Frequently-Asked-Questions-(FAQ)). -- For basic questions try asking on [Discord](https://discord.gg/tQcWEUp), [Reddit](https://www.reddit.com/r/Tautulli), or the [Plex Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) first before opening an issue. - -##### If nothing has worked: - -1. Open a new issue on the GitHub [issue tracker](http://github.com/JonnyWong16/plexpy/issues). -2. Provide a clear title to easily help identify your problem. -3. Use proper [markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post (i.e. code/log in code blocks). -4. Make sure you provide the following information: - - [ ] Version - - [ ] Branch - - [ ] Commit hash - - [ ] Operating system - - [ ] Python version - - [ ] What you did? - - [ ] What happened? - - [ ] What you expected? - - [ ] How can we reproduce your issue? - - [ ] What are your (relevant) settings? - - [ ] Include a link to your **FULL** (not just a few lines!) log file that has the error. Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/). -5. Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. - -## Feature Requests - -Feature requests are handled on [FeatHub](http://feathub.com/JonnyWong16/plexpy). - -1. Search the existing requests to see if your suggestion has already been submitted. -2. If a similar request exists, give it a thumbs up (+1), or add additional comments to the request. -3. If no similar requests exist, you can create a new one. Make sure to provide a clear title to easily identify the feature request. +* Please see the [Issues Repository](https://github.com/Tautulli/Tautulli-Issues). ## License diff --git a/data/interfaces/default/base.html b/data/interfaces/default/base.html index 58279bdc..7c76a193 100644 --- a/data/interfaces/default/base.html +++ b/data/interfaces/default/base.html @@ -49,7 +49,7 @@ % elif plexpy.CONFIG.CHECK_GITHUB and plexpy.CURRENT_VERSION != plexpy.LATEST_VERSION and plexpy.COMMITS_BEHIND > 0 and plexpy.INSTALL_TYPE != 'win': diff --git a/data/interfaces/default/configuration_table.html b/data/interfaces/default/configuration_table.html index 81b476d8..45d704fe 100644 --- a/data/interfaces/default/configuration_table.html +++ b/data/interfaces/default/configuration_table.html @@ -22,11 +22,11 @@ DOCUMENTATION :: END % if plexpy.CURRENT_VERSION: Git Branch: - ${plexpy.CONFIG.GIT_BRANCH} + ${plexpy.CONFIG.GIT_BRANCH} Git Commit Hash: - ${plexpy.CURRENT_VERSION} + ${plexpy.CURRENT_VERSION} % endif @@ -75,10 +75,10 @@ DOCUMENTATION :: END Resources: Tautulli Website | - GitHub Source | - GitHub Issues | - GitHub Wiki & FAQ | - FeatHub Feature Requests | + GitHub Source | + GitHub Issues | + GitHub Wiki | + FeatHub Feature Requests @@ -86,7 +86,7 @@ DOCUMENTATION :: END Tautulli Discord Server | Tautulli Subreddit | - Plex Forums + Plex Forums diff --git a/data/interfaces/default/settings.html b/data/interfaces/default/settings.html index 218dae97..745219e5 100644 --- a/data/interfaces/default/settings.html +++ b/data/interfaces/default/settings.html @@ -1103,8 +1103,8 @@
- Please read the guidelines - in the CONTRIBUTING document
before submitting a new ! + Please read the guidelines + in the README document
before submitting a new !

Your post may be removed for failure to follow the guidelines.
@@ -1125,7 +1125,7 @@
- Please read the FAQ + Please read the FAQ before asking for help!
diff --git a/plexpy/config.py b/plexpy/config.py index 29645757..48d8b192 100644 --- a/plexpy/config.py +++ b/plexpy/config.py @@ -176,8 +176,8 @@ _CONFIG_DEFINITIONS = { 'GIT_PATH': (str, 'General', ''), 'GIT_REMOTE': (str, 'General', 'origin'), 'GIT_TOKEN': (str, 'General', ''), - 'GIT_USER': (str, 'General', 'JonnyWong16'), - 'GIT_REPO': (str, 'General', 'plexpy'), + 'GIT_USER': (str, 'General', 'Tautulli'), + 'GIT_REPO': (str, 'General', 'Tautulli'), 'GRAPH_TYPE': (str, 'General', 'plays'), 'GRAPH_DAYS': (int, 'General', 30), 'GRAPH_MONTHS': (int, 'General', 12), @@ -883,3 +883,9 @@ class Config(object): self.PMS_UPDATE_CHANNEL = 'beta' self.CONFIG_VERSION = 10 + + if self.CONFIG_VERSION == 10: + self.GIT_USER = 'Tautulli' + self.GIT_REPO = 'Tautulli' + + self.CONFIG_VERSION = 11 diff --git a/plexpy/notifiers.py b/plexpy/notifiers.py index 38d3a491..a099db86 100644 --- a/plexpy/notifiers.py +++ b/plexpy/notifiers.py @@ -896,7 +896,8 @@ class ANDROIDAPP(Notifier): 'The content of your notifications will be sent unencrypted!
' \ 'Please install the library to encrypt the notification contents. ' \ 'Instructions can be found in the ' \ - 'FAQ.', + 'FAQ.', 'input_type': 'help' }) else: diff --git a/plexpy/versioncheck.py b/plexpy/versioncheck.py index 4259ccc3..6decab1d 100644 --- a/plexpy/versioncheck.py +++ b/plexpy/versioncheck.py @@ -136,7 +136,9 @@ def checkGithub(auto_update=False): # Get the latest version available from github logger.info('Retrieving latest version information from GitHub') - url = 'https://api.github.com/repos/%s/plexpy/commits/%s' % (plexpy.CONFIG.GIT_USER, plexpy.CONFIG.GIT_BRANCH) + url = 'https://api.github.com/repos/%s/%s/commits/%s' % (plexpy.CONFIG.GIT_USER, + plexpy.CONFIG.GIT_REPO, + plexpy.CONFIG.GIT_BRANCH) if plexpy.CONFIG.GIT_TOKEN: url = url + '?access_token=%s' % plexpy.CONFIG.GIT_TOKEN version = request.request_json(url, timeout=20, validator=lambda x: type(x) == dict) @@ -157,7 +159,10 @@ def checkGithub(auto_update=False): return plexpy.LATEST_VERSION logger.info('Comparing currently installed version with latest GitHub version') - url = 'https://api.github.com/repos/%s/plexpy/compare/%s...%s' % (plexpy.CONFIG.GIT_USER, plexpy.LATEST_VERSION, plexpy.CURRENT_VERSION) + url = 'https://api.github.com/repos/%s/%s/compare/%s...%s' % (plexpy.CONFIG.GIT_USER, + plexpy.CONFIG.GIT_REPO, + plexpy.LATEST_VERSION, + plexpy.CURRENT_VERSION) if plexpy.CONFIG.GIT_TOKEN: url = url + '?access_token=%s' % plexpy.CONFIG.GIT_TOKEN commits = request.request_json(url, timeout=20, whitelist_status_code=404, validator=lambda x: type(x) == dict) @@ -175,7 +180,7 @@ def checkGithub(auto_update=False): if plexpy.COMMITS_BEHIND > 0: logger.info('New version is available. You are %s commits behind' % plexpy.COMMITS_BEHIND) - url = 'https://api.github.com/repos/%s/plexpy/releases' % plexpy.CONFIG.GIT_USER + url = 'https://api.github.com/repos/%s/%s/releases' % (plexpy.CONFIG.GIT_USER, plexpy.CONFIG.GIT_REPO) releases = request.request_json(url, timeout=20, whitelist_status_code=404, validator=lambda x: type(x) == list) if releases is None: diff --git a/plexpy/webserve.py b/plexpy/webserve.py index d789817a..b10d7328 100644 --- a/plexpy/webserve.py +++ b/plexpy/webserve.py @@ -62,7 +62,7 @@ def serve_template(templatename, **kwargs): http_root = plexpy.HTTP_ROOT server_name = plexpy.CONFIG.PMS_NAME - cache_param = '?' + plexpy.CURRENT_VERSION or common.VERSION_NUMBER + cache_param = '?' + (plexpy.CURRENT_VERSION or common.VERSION_NUMBER) _session = get_session_info()