Changes between Version 46 and Version 47 of TracDownloaderPlugin


Ignore:
Timestamp:
Nov 12, 2016, 9:42:53 AM (7 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TracDownloaderPlugin

    v46 v47  
    55== Description
    66
    7 This plugin implements a project release downloader for Trac system. This downloader allows your users to download released software or even release candidates.
     7This plugin implements a project release downloader in your Trac installation. This downloader allows your users to download software, such as releases or release candidates. The downloader also maintains statistics of downloads from your Trac installation.
    88
    9 A typical use case would be the release of upgrades to your released software for your external users to download. It has an optional questionnaire before the download of file(s), Captcha antirobot check, stats module and easy to use administration in Trac WebAdmin plugin.
     9Key features:
     10 * Presents the user with downloadable files, such as software releases.
     11 * Optionally presents the user with a questionnaire before the download of file(s).
     12 * Captcha antirobot check.
     13 * Maintains statistics on downloads.
     14 * Easy to use administration in the Trac WebAdmin page.
     15
     16A typical use case would be the release of upgrades to your released software for your external users to download.
    1017
    1118See also DownloadsPlugin.
     
    1320=== Screenshots
    1421
    15  * [attachment:04_downloads.png View on Main list of downloads]
    16  * [attachment:08_questionnaire.png Questionnaire with captha to get information about user who downloads]
     22[[Image(04_downloads.png)]]
     23
     24 * [attachment:04_downloads.png View on Main list of downloads]: see above
     25 * [attachment:08_questionnaire.png Questionnaire with captcha to get information about user who downloads]
    1726 * [attachment:01_files_admin.png Administration of files for download]
    1827 * [attachment:03_stats_admin.png Administration of statistics and questionnaire fill ups]
    19  * [attachment:06_year_stats.png Statistics of downloads by years]
    20  * [attachment:05_month_stats.png Statistics of downloads by months]
     28 * [attachment:06_year_stats.png Statistics of downloads by year]
     29 * [attachment:05_month_stats.png Statistics of downloads by month]
    2130 * [attachment:07_file_stats.png Statistics of files (releases and categories has this too)]
    2231
     
    6271'''Using Python egg'''
    6372
    64 The easiest way to start using the Downloader plugin is to get download the Python egg into the plugin directory of your project environment (egg is most probably Python version independent, just rename it, there is still the source package). After that you must turn both modules of Downloader on in WebAdmin/plugins: the Downloader is dependent on WebAdmin plugin. And finally you need to get apply the permissions of Downloader to the users. In this case if you like to use !PyCaptcha, you must install it yourself, !PyCaptcha is dependent on Python Imaging Library (PIL) so you must download it too.
     73The easiest way to start using the Downloader plugin is to get download the Python egg into the plugin directory of your project environment. The egg is most probably Python version independent, just rename it, there is still the source package. After that you must turn both modules of Downloader on in WebAdmin/plugins: the Downloader is dependent on WebAdmin plugin. And finally you need to apply the permissions of Downloader to the users. In this case if you like to use !PyCaptcha, you must install it yourself, !PyCaptcha is dependent on the Python Imaging Library (PIL) so you must download it too.
    6574
    6675'''Using source''' - installation with !PyCaptcha and PIL which are needed for Captcha to work:
     
    7281}}}
    7382
    74 '''Second and maybe better way''' is to download and unpack somewhere source zip package and then just run "setup.py install" (or on Windows maybe better "python setup.py install") or you can just use easy_install commands written above. Setup just installs TracDownloaderPlugin. If you like to use Captcha tests you have to install PIL and !PyCaptcha manually either (note that PIL is in most ''Linux distributions'' package named '''python-imaging''' so you don't need to install it by easy install but you can use your package manager).
     83'''Using setup.py install''' An alternative and maybe better way is to download and unpack somewhere the source zip package and then just run "setup.py install" or on Windows maybe better "python setup.py install", or you can just use the easy_install commands written above. Setup just installs TracDownloaderPlugin. If you like to use Captcha tests you have to install PIL and !PyCaptcha manually also. Note that PIL is in most ''Linux distributions'' package named '''python-imaging''' so you don't need to install it by easy install, and you can use your package manager.
    7584
    76 Then you must enable both Downloader modules in !TracAdmin/Plugins (or enable Downloader components in your environment's `trac.ini` file - source bottom) and assign some permissions of downloader to someone and you can start trying Downloader plugin:
     85Then you must enable both Downloader modules in !TracAdmin/Plugins (or enable Downloader components in your environment's `trac.ini` file - source bottom) and assign some permissions of downloader to someone and you can start using Downloader plugin:
    7786
    7887{{{#!ini
     
    8291}}}
    8392
    84 After the steps above and clicking to any part of Downloader you should be asked about location of directory to store uploaded files. When it is set up, you must Submit that form two times and there can occur exception "!DatabaseError: database schema has changed". If this exception is thrown, it is best to restart your http server.
     93After the steps above and clicking to any part of Downloader you should be asked about location of directory to store uploaded files. When it is set up, you must Submit that form two times and there can be an exception "!DatabaseError: database schema has changed". If this exception is thrown, it is best to restart your http server.
    8594
    86 Downloader keeps using '''!ClearSilver''' as templating system so you have to have it installed (version for new templating system Genshi will be written soon). '''Version for Trac 0.11 wasn't too much tested so if you find errors, please write me a ticket.'''
     95Downloader keeps using '''!ClearSilver''' as templating system so you have to have it installed. A version of this plugin for the Genshi templating system is under development. '''Version for Trac 0.11 wasn't too much tested, so if you find errors, please write me a ticket.'''
    8796
    88 '''If you had problems installing Downloader, please write me a ticket or write solution of your installation problems here.'''
     97'''If you had problems installing Downloader, please write me a ticket or write the solution of your installation problems here.'''
    8998
    9099== Permissions
     
    113122}}}
    114123
    115 If item of that id doesn't exist, there is displayed a dead link with title "id not found". If the file was deleted, it still displays its correct name, but does not link to anywhere.
     124If item of that id doesn't exist, a dead link is displayed with title "id not found". If the file was deleted, it still displays its correct name, but does not link to anywhere.
    116125
    117126== Special features
     
    120129
    121130'''MIME list'''
    122 In tracdownloader directory there is a file mime_list.txt which contains list of known MIME types for Downloader, you can easily add new ones or delete unneeded, if there is no record found for particular file extension in this list, Downloader uses MIME of application/octet-stream.
     131In tracdownloader directory there is a file mime_list.txt which contains a list of known MIME types for Downloader, you can easily add new ones or delete unneeded ones, if there is no record found for particular file extension in this list, Downloader uses MIME of application/octet-stream.
    123132
    124133'''EDIT QUESTIONNAIRE'''
    125 The file form_data.py contains the structure used to generate questionnaire before the download of the file. You can easily edit this to get from users the data you want. There is big description inside of this file.
     134The file form_data.py contains the structure used to generate the questionnaire before the download of the file. You can easily edit this to get the data you want from your users. There is a description inside this file.
    126135
    127136== Reset all statistics
    128137
    129 To clear all recorded data about downloads and users who downloaded anything by !DownloaderPlugin you can use on your Trac environment database these two SQL commands.
     138To clear all recorded data about downloads and users who downloaded anything by !DownloaderPlugin, you can use on your Trac environment database these two SQL commands:
    130139{{{#!sql
    131140DELETE FROM downloader_downloaded_attributes;
     
    133142}}}
    134143
    135 After this '''all statistics are gone'''.
     144After executing this '''all statistics are gone'''.
    136145
    137146== Recent Changes