To get your questions answered, please ask in the [SickRage Forum], on IRC \#sickrage pn freenode.net, or webchat.
To get your questions answered, please ask in the [SickGear Forum], on IRC \#SickGear pn freenode.net, or webchat.
# Contributing to SickRage
# Contributing to SickGear
1. [Getting Involved](#getting-involved)
2. [How To Report Bugs](#how-to-report-bugs)
@ -11,30 +11,30 @@ To get your questions answered, please ask in the [SickRage Forum], on IRC \#sic
## Getting Involved
There are a number of ways to get involved with the development of SickRage. Even if you've never contributed code to an Open Source project before, we're always looking for help identifying bugs, cleaning up code, writing documentation and testing.
There are a number of ways to get involved with the development of SickGear. Even if you've never contributed code to an Open Source project before, we're always looking for help identifying bugs, cleaning up code, writing documentation and testing.
The goal of this guide is to provide the best way to contribute to the official SickRage repository. Please read through the full guide detailing [How to Report Bugs](#how-to-report-bugs).
The goal of this guide is to provide the best way to contribute to the official SickGear repository. Please read through the full guide detailing [How to Report Bugs](#how-to-report-bugs).
## Discussion
### Forum and IRC
### Issues and IRC
The SickRage development team frequently tracks posts on the [SickRage Forum](http://sickrage.tv/). If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](#how-to-report-bugs).
If you think you've found a bug please [file it in the bug tracker](#how-to-report-bugs).
Additionally most of the SickRage development team can be found in the [#sickrage](http://webchat.freenode.net/?channels=sickrage) IRC channel on irc.freenode.net.
Additionally most of the SickGear development team can be found in the [#SickGear](http://webchat.freenode.net/?channels=SickGear) IRC channel on irc.freenode.net.
## How to Report Bugs
### Make sure it is a SickRage bug
### Make sure it is a SickGear bug
Many bugs reported are actually issues with the user mis-understanding of how something works (there are a bit of moving parts to an ideal setup) and most of the time can be fixed by just changing some settings to fit the users needs.
If you are new to SickRage, it is usually a much better idea to ask for help first in the [Using SickRage Forum](http://sickrage.tv) or the [SickRage IRC channel](http://webchat.freenode.net/?channels=sickrage). You will get much quicker support, and you will help avoid tying up the SickRage team with invalid bug reports.
If you are new to SickGear, it is usually a much better idea to ask for help first in the [SickGear IRC channel](http://webchat.freenode.net/?channels=SickGear). You will get much quicker support, and you will help avoid tying up the SickGear team with invalid bug reports.
### Try the latest version of SickRage
### Try the latest version of SickGear
Bugs in old versions of SickRage may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the latest build/source. Also, we put new code in the `dev` branch first before pushing down to the `master` branch (which is what the binary builds are built off of).
Bugs in old versions of SickGear may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the latest build/source. Also, we put new code in the `dev` branch first before pushing down to the `master` branch (which is what the binary builds are built off of).
## Tips For Submitting Code
@ -51,14 +51,14 @@ Please follow these guidelines before reporting a bug:
1. **Update to the latest version**— Check if you can reproduce the issue with the latest version from the `dev` branch.
2. **Use the SickRage Forums search**— check if the issue has already been reported. If it has been, please comment on the existing issue.
2. **Use the SickGear Forums search**— check if the issue has already been reported. If it has been, please comment on the existing issue.
3. **Provide a means to reproduce the problem**— Please provide as much details as possible, e.g. SickRage log files (obfuscate apikey/passwords), browser and operating system versions, how you started SickRage, and of course the steps to reproduce the problem. Bugs are always reported in the forums.
3. **Provide a means to reproduce the problem**— Please provide as much details as possible, e.g. SickGear log files (obfuscate apikey/passwords), browser and operating system versions, how you started SickGear, and of course the steps to reproduce the problem. Bugs are always reported in the forums.
### Feature requests
Please follow the bug guidelines above for feature requests, i.e. update to the latest version and search for existing issues before posting a new request. You can submit Feature Requests in the [SickRage Forum] as well.
Please follow the bug guidelines above for feature requests, i.e. update to the latest version and search for existing issues before posting a new request. You can submit Feature Requests in the [SickGear Forum] as well.
### Pull requests
@ -85,9 +85,9 @@ Please follow this process; it's the best way to get your work included in the p
```bash
# clone your fork of the repo into the current directory in terminal
<p>Settings that dictate how SickRage should process completed downloads.</p>
<p>Settings that dictate how SickGear should process completed downloads.</p>
</div>
<fieldset class="component-group-list">
@ -57,7 +57,7 @@
</label>
<label class="nocheck">
<span class="component-title"> </span>
<span class="component-desc">Or if SABnzbd+ and SickRage are on different PCs.</span>
<span class="component-desc">Or if SABnzbd+ and SickGear are on different PCs.</span>
</label>
</div>
@ -91,7 +91,7 @@
</label>
<label class="nocheck">
<span class="component-title"> </span>
<span class="component-desc"><b>NOTE:</b> This may mean SickRage misses renames as well</span>
<span class="component-desc"><b>NOTE:</b> This may mean SickGear misses renames as well</span>
</label>
</div>
<div class="field-pair">
@ -105,7 +105,7 @@
</label>
<label class="nocheck">
<span class="component-title"> </span>
<span class="component-desc"><b>NOTE:</b> Scripts are called after SickRage's own post-processing.</span>
<span class="component-desc"><b>NOTE:</b> Scripts are called after SickGear's own post-processing.</span>
</label>
</div>
@ -228,7 +228,7 @@
<div class="component-group-desc">
<h3>Episode Naming</h3>
<p>How SickRage will name and sort your episodes.</p>
<p>How SickGear will name and sort your episodes.</p>
</div>
<fieldset class="component-group-list">
@ -371,7 +371,7 @@
<td>Show.Name.S02E03.HDTV.XviD-RLSGROUP</td>
</tr>
<tr>
<td class="align-right"><i class="icon-info-sign" title="'SiCKRAGE' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td class="align-right"><i class="icon-info-sign" title="'SickGear' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td>%RG</td>
<td>RLSGROUP</td>
</tr>
@ -579,7 +579,7 @@
<td>Show.Name.2010.03.09.HDTV.XviD-RLSGROUP</td>
</tr>
<tr class="even">
<td class="align-right"><i class="icon-info-sign" title="'SiCKRAGE' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td class="align-right"><i class="icon-info-sign" title="'SickGear' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td class="align-right"><i class="icon-info-sign" title="'SiCKRAGE' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td class="align-right"><i class="icon-info-sign" title="'SickGear' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td>%RG</td>
<td>RLSGROUP</td>
</tr>
@ -929,7 +929,7 @@
<td>Show.Name.S02E03.HDTV.XviD-RLSGROUP</td>
</tr>
<tr>
<td class="align-right"><i class="icon-info-sign" title="'SiCKRAGE' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<td class="align-right"><i class="icon-info-sign" title="'SickGear' is used in place of RLSGROUP if it could not be properly detected"></i> <b>Release Group:</b></td>
<p>SickRage can add existing shows, using the current options, by using locally stored NFO/XML metadata to eliminate user interaction.<br />
If you would rather have SickRage prompt you to customize each show, then use the checkbox below.</p>
<p>SickGear can add existing shows, using the current options, by using locally stored NFO/XML metadata to eliminate user interaction.<br />
If you would rather have SickGear prompt you to customize each show, then use the checkbox below.</p>
<p><input type="checkbox" name="promptForSettings" id="promptForSettings" /> <label for="promptForSettings">Prompt me to set settings for each show</label></p>
<hr />
<h5><b>Displaying folders within these directories which aren't already added to SickRage:</b></h5>
<h5><b>Displaying folders within these directories which aren't already added to SickGear:</b></h5>
<p>For shows that you haven't downloaded yet, this option finds a show on theTVDB.com and TVRage.com, creates a directory for its episodes, and adds it to SickRage.</p>
<p>For shows that you haven't downloaded yet, this option finds a show on theTVDB.com and TVRage.com, creates a directory for its episodes, and adds it to SickGear.</p>
<p>For shows that you haven't downloaded yet, this option lets you choose from a list of current trending shows with ratings to add, creates a directory for its episodes, and adds it to SickRage.</p>
<p>For shows that you haven't downloaded yet, this option lets you choose from a list of current trending shows with ratings to add, creates a directory for its episodes, and adds it to SickGear.</p>
<p>For shows that you haven't downloaded yet, this option recommends shows to add based on your Trakt.tv show library, creates a directory for its episodes, and adds it to SickRage.</p>
<p>For shows that you haven't downloaded yet, this option recommends shows to add based on your Trakt.tv show library, creates a directory for its episodes, and adds it to SickGear.</p>
<p>Use this option to add shows that already have a folder created on your hard drive. SickRage will scan your existing metadata/episodes and add the show accordingly.</p>
<p>Use this option to add shows that already have a folder created on your hard drive. SickGear will scan your existing metadata/episodes and add the show accordingly.</p>
SickRage is a Video File Manager for TV Shows, It watches for new episodes of your favorite shows and when they are posted it does its magic.
SickGear is a Video File Manager for TV Shows, It watches for new episodes of your favorite shows and when they are posted it does its magic.
*SickRage is currently in beta release stage. There may be severe bugs in it and at any given time it may not work at all.*
*SickGear is currently in beta release stage. There may be severe bugs in it and at any given time it may not work at all.*
There are currently a lot of changes that we're working on, which affect the very core of how SickRage works. We're doing this to lay the groundwork
for making SickRage seriously more awesome, scalable and resource-friendly than it already is.
There are currently a lot of changes that we're working on, which affect the very core of how SickGear works. We're doing this to lay the groundwork
for making SickGear seriously more awesome, scalable and resource-friendly than it already is.
While we're doing this, please expect SickRage do strange things, or maybe even not work at all. In any case, we need your help. If you see SickRage behaving weird, check if someone has reported it, and if not, open a new issue. There is little to no use to report "software should be stable". We will focus on that later, not now.
While we're doing this, please expect SickGear do strange things, or maybe even not work at all. In any case, we need your help. If you see SickGear behaving weird, check if someone has reported it, and if not, open a new issue. There is little to no use to report "software should be stable". We will focus on that later, not now.
!!! Please before using this with your existing database (sickbeard.db) please make a backup copy of it and delete any other database files such as cache.db and failed.db if present, we HIGHLY recommend starting out with no database files at all to make this a fresh start but the choice is at your own risk !!!
@ -30,12 +30,12 @@ FEATURES:
## Dependencies
To run SickRage from source you will need Python 2.6+ and Cheetah 2.1.0+.
To run SickGear from source you will need Python 2.6+ and Cheetah 2.1.0+.
## Forums
Any questions or setup info your looking for can be found at out forums https://www.sickrage.tv
Any questions or setup info your looking for can be found at our [wiki](https://github.com/SickGear/SickGear/wiki)
<br>
If you find a bug please report at our forums https://sickrage.tv/forums/forum/help-support/bug-issue-reports
If you find a bug please report at our [SickGear IRC channel](http://webchat.freenode.net/?channels=SickGear)
<br>
Be sure to provide a sickrage log in debug mode where is the error evidence or it'll never get fixed.
Be sure to provide a SickGear log at pastebin.com in debug mode where the error is evidence or it'll never get fixed.
# Author: jkaberg <joel.kaberg@gmail.com>, based on fuzemans work (https://github.com/RuudBurger/CouchPotatoServer/blob/develop/couchpotato/core/downloaders/rtorrent/main.py)
# URL: http://code.google.com/p/sickbeard/
#
# This file is part of SickRage.
# This file is part of SickGear.
#
# SickRage is free software: you can redistribute it and/or modify
# SickGear is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# SickRage is distributed in the hope that it will be useful,
# SickGear is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with SickRage. If not, see <http://www.gnu.org/licenses/>.
# along with SickGear. If not, see <http://www.gnu.org/licenses/>.
Supremicus
11 years ago
JackDandy
