doc/dev/files-overview.rst

   1 File Overview
   2 =============
   3
   4 The ``mygpo`` project consists of the following files ::
   5
   6   mygpo/
   7     __init__.py
   8     settings.py                                                # default settings
   9     settings_prod.py                                           # "productive" settings which overwrite those in settings.py
  10     cache.py                                                   # utils around Django's cache
  11     manage.py                                                  # https://docs.djangoproject.com/en/dev/ref/django-admin/
  12     constants.py                                               # defines some global constants
  13     flattr.py                                                  # Flattr support (https://flattr.com/)
  14     utils.py                                                   # utilities
  15     cel.py                                                     # Celery integration (http://celeryproject.org/)
  16     urls.py                                                    # Django URL dispatcher (https://docs.djangoproject.com/en/dev/topics/http/urls/)
  17     shell.py                                                   # import * for commonly used methods when working in the Django shell
  18     test.py                                                    # custom Django test suite runner
  19     decorators.py                                              # globally used decorators
  20     print-couchdb.py                                           # script to print the main CouchDB database
  21
  22     admin/                                                     # functionality to be used by site-admins
  23       auth.py                                                  # authentication of admins
  24       group.py                                                 # groups / matches episodes (eg for merging)
  25       clients.py                                               # client statistics
  26       views.py                                                 # Django views for the admin area (https://docs.djangoproject.com/en/dev/topics/http/views/)
  27       urls.py                                                  # Django URL dispatcher for the admin area
  28       tasks.py                                                 # Celery tasks
  29
  30     maintenance/
  31       merge.py                                                 # Merging of podcasts and related objects
  32       management/changescmd.py                                 # base class for commands that use the CouchDB changes feed (https://couchdb.readthedocs.org/en/latest/changes.html)
  33       management/podcastcmd.py                                 # base class for commands that operate on (multiple) podcasts
  34       management/commands/celery.py                            # Celery worker
  35       management/commands/assign-podcast-slugs.py              # assigns slugs to podcasts (one-time command, now unused)
  36       management/commands/cleanup-unused-users.py              # removes users that have been marked as deleted
  37       management/commands/assign-episode-slugs.py              # assigns slugs to episodes (one-time command, now unused)
  38       management/commands/listening-stats.py                   # stats about the intervald between publishing and playing episodes
  39       management/commands/merge-episode-states.py              # merges duplicates of episodes states
  40       management/commands/move-subscriber-data.py              # moves subscriber data from podcasts into separate objects
  41       management/commands/import-episode-actions.py            # imports episode actions from files
  42       management/commands/sync-sanitizing-rules.py             # synchronizes sanitizing rules to the database
  43       management/commands/delete-sanitizing-rules.py           # deletes sanitizing rules
  44
  45     data/                                                      # stuff related to podcast and episode data
  46       youtube.py                                               # utils for accessing YouTube data
  47       delicious.py                                             # utils for accessing delicious.com data
  48       flickr.py                                                # utils for accessing Flickr data
  49       podcast.py                                               # podcast-related utils
  50       mimetype.py                                              # utils for handling mime types
  51       signals.py                                               # Django Signals for podcast-related events (https://docs.djangoproject.com/en/dev/topics/signals/)
  52       tasks.py                                                 # podcast-related Celery tasks
  53       feeddownloader.py                                        # fetching, parsing and updating podcasts based on their feeds
  54       management/commands/feed-downloader.py                   # command-wrapper around feeddownloader.py
  55       management/commands/update-related-podcasts.py           # calculates and sets related podcasts for existing podcasts
  56       management/commands/tag-downloader.py                    # fetches and updates tags for existing podcasts
  57       management//commands/group-podcasts.py                   # group two related podcasts
  58
  59     publisher/
  60       __init__.py
  61       auth.py
  62       tests.py
  63       forms.py
  64       utils.py
  65       views.py
  66       urls.py
  67       management/__init__.py
  68       management/commands/make-publisher.py
  69       management/commands/__init__.py
  70       templatetags/__init__.py
  71       templatetags/pcharts.py
  72
  73     users/
  74       __init__.py
  75       tests.py
  76       sync.py
  77       models.py
  78       settings.py
  79       ratings.py
  80       signals.py
  81       tasks.py
  82       subscriptions.py
  83       management/__init__.py
  84       management/commands/__init__.py
  85       management/commands/assign-upload-timestamps.py
  86
  87     api/
  88       __init__.py
  89       tests.py
  90       backend.py
  91       constants.py
  92       opml.py
  93       legacy.py
  94       models.py
  95       exceptions.py
  96       views.py
  97       urls.py
  98       basic_auth.py
  99       httpresponse.py
 100       simple.py
 101       sanitizing.py
 102       tasks.py
 103       advanced/auth.py
 104       advanced/sync.py
 105       advanced/lists.py
 106       advanced/settings.py
 107       advanced/__init__.py
 108       advanced/episode.py
 109       advanced/directory.py
 110       management/commands/__init__.py
 111       management/commands/sanitizing-maintenance.py
 112       management/__init__.py
 113
 114     directory/
 115       __init__.py
 116       tests.py
 117       models.py
 118       views.py
 119       urls.py
 120       search.py
 121       toplist.py
 122       tags.py
 123       tasks.py
 124       management/__init__.py
 125       management/commands/__init__.py
 126       management/commands/category-merge-spellings.py
 127       management/commands/update-episode-toplist.py
 128       management/commands/set-example-podcasts.py
 129       management/commands/update-toplist.py
 130
 131     pubsub
 132       models.py
 133       views.py
 134       urls.py
 135       __init__.py
 136       signals.py
 137
 138     web/
 139       __init__.py
 140       auth.py
 141       tests.py
 142       forms.py
 143       google.py
 144       utils.py
 145       logo.py
 146       urls.py
 147       heatmap.py
 148       views/__init__.py
 149       views/podcast.py
 150       views/settings.py
 151       views/subscriptions.py
 152       views/device.py
 153       views/users.py
 154       views/episode.py
 155       views/security.py
 156       templatetags/__init__.py
 157       templatetags/devices.py
 158       templatetags/facebook.py
 159       templatetags/youtube.py
 160       templatetags/google.py
 161       templatetags/utils.py
 162       templatetags/time.py
 163       templatetags/flickr.py
 164       templatetags/math.py
 165       templatetags/mygpoutil.py
 166       templatetags/menu.py
 167       templatetags/charts.py
 168       templatetags/podcasts.py
 169       templatetags/episodes.py
 170       templatetags/googleanalytics.py
 171       management/__init__.py
 172       management/commands/__init__.py
 173
 174     userfeeds/
 175       __init__.py
 176       auth.py
 177       tests.py
 178       feeds.py
 179       views.py
 180       urls.py
 181
 182     core/
 183       __init__.py
 184       tests.py
 185       oldid.py
 186       json.py
 187       models.py
 188       proxy.py
 189       signals.py
 190       podcasts.py
 191       tasks.py
 192       graphite.py
 193       slugs.py
 194       management/__init__.py
 195       management/commands/__init__.py
 196
 197     share/
 198       __init__.py
 199       userpage.py
 200       models.py
 201       views.py
 202       urls.py
 203       templatetags/__init__.py
 204       templatetags/gravatar.py
 205
 206     db/
 207       __init__.py
 208
 209     db/couchdb/
 210       __init__.py
 211       common.py
 212       episode_state.py
 213       utils.py
 214       user.py
 215       models.py
 216       podcast_state.py
 217       podcast.py
 218       podcastlist.py
 219       episode.py
 220       directory.py
 221       pubsub.py
 222       management/__init__.py
 223       management/commands/__init__.py
 224       management/commands/touch-couchdb-views.py
 225       management/commands/compact-couchdb.py
 226       management/commands/dump-sample.py
 227       management/commands/sync-design-docs.py
 228       management/commands/count-view-usage.py