Metadata-Version: 1.1
Name: django-phpBB3
Version: 0.0.1.0723
Summary: django database models of phpBB3
Home-page: https://github.com/jedie/django-phpBB3/
Author: Jens Diemer
Author-email: django-phpBB3@jensdiemer.de
License: UNKNOWN
Download-URL: http://pypi.python.org/pypi/django-phpBB3/
Description: -------------
        Django-phpBB3
        -------------
        
        Django-phpBB3 provides the database models of a existing phpBB3 installation for easy migration into a other forum software.
        It's not a phpBB clone or a forum!
        
        Warning:
        In the current state, it's not guaranteed that changes trough the django admin will work with phpBB3!
        So in the current state, access 'read-only' to the data ;)
        
        Patches are welcome! Please send pull requests.
        
        ----------------
        example projects
        ----------------
        
        We add two example projects:
        
        +-------------------------------+-----------------------------------------------------------------------------+
        | **`django_phpBB3_project`_**  | minimal project without extra depencies                                     |
        +-------------------------------+-----------------------------------------------------------------------------+
        | **`phpBB2DjangoBB_project`_** | DjangoBB example project which include the phpBB2DjangoBB migration command |
        +-------------------------------+-----------------------------------------------------------------------------+
        
        .. _django_phpBB3_project: https://github.com/jedie/django-phpBB3/tree/master/django_phpBB3_project
        .. _phpBB2DjangoBB_project: https://github.com/jedie/django-phpBB3/tree/master/phpBB2DjangoBB_project
        
        ------------------
        test django-phpBB3
        ------------------
        
        We added a test project for easy start in: `/django_phpBB3_project/ <https://github.com/jedie/django-phpBB3/tree/master/django_phpBB3_project>`_
        
        Create a ``local_settings.py`` in ``/django_phpBB3_project/``
        At least you must setup ``DATABASES``, e.g:
        
        ::
        
            DATABASES = {
                'default': {
                    'ENGINE': 'django.db.backends.mysql', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
                    'NAME': 'phpbb3', # Or path to database file if using sqlite3.
                    'USER': 'phpbb3', # Not used with sqlite3.
                    'PASSWORD': 'foo bar', # Not used with sqlite3.
                    'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
                    'PORT': '', # Set to empty string for default. Not used with sqlite3.
                }
            }
        
        optional settings, that you can change in your ``local_settings.py`` are:
        
        ::
        
            # The prefix of the phpBB3 installation - default: u"phpbb3_"
            PHPBB_TABLE_PREFIX = u"phpbb3_"
        
        You must create the django tables with: ``./manage.py syncdb`` and create a superuser.
        
        You can startup a test server with, e.g:
        
        ::
        
            ./manage.py runserver --traceback --insecure
        
        -----------------------------------------
        migrate a phpBB3 installation to DjangoBB
        -----------------------------------------
        
        **not complete implemented, yet!**
        
        The migration from phpBB3 to DjangoBB is implement as a migration command here: `/django_phpBB3/management/commands/phpbb2djangobb.py <https://github.com/jedie/django-phpBB3/blob/master/django_phpBB3/management/commands/phpbb2djangobb.py>`_ 
        
        To run the migration you can use the minimal ``phpBB2DjangoBB`` example project example.
        This project includes the DjangoBB forum app and django-phpBB3 app. Before start, you must install the dependencies!
        
        You must add to a ``local_settings.py`` into `/phpBB2DjangoBB_project/ <https://github.com/jedie/django-phpBB3/tree/master/phpBB2DjangoBB_project>`_ this settings:
        
        ::
        
            # filesystem path to the /files/ sub directory of the phpBB installation:
            PHPBB_ATTACHMENT_PATH = "/path/to/phpBB/files/"
        
        (You must also point the attachment directory from DjangoBB to a existing filesystem path.)
        
        Run the migration with:
        
        ::
        
            cd phpBB2DjangoBB_project
            phpBB2DjangoBB_project$ ./manage.py phpbb2djangobb
        
        options
        =======
        
        cleanup_users
        -------------
        
        Add ``--cleanup_users=x`` to setup which users are migrate, where **x** is a number:
        
        +-------+-----------------------------------------------------------+
        | **0** | all users                                                 |
        +-------+-----------------------------------------------------------+
        | **1** | users with email addresses (skip bots)                    |
        +-------+-----------------------------------------------------------+
        | **2** | users with email and has a 'lastvisit' date **(default)** |
        +-------+-----------------------------------------------------------+
        | **3** | email + lastvisit and has created at least one post       |
        +-------+-----------------------------------------------------------+
        
        migration notes
        ===============
        
        limitations
        -----------
        
        Things that would not be transfered, yet:
        
        * Forum moderators
        
        * Category groups
        
        * sort of in Category / Forum would not be converted to position number
        
        * ForumWatch / TopicWatch can't be converted because the models are unsupported
        
        Handling missing features in DjangoBB:
        
        * We transfer phpBB Users who are in the user group ``ADMINISTRATORS`` or ``GLOBAL_MODERATORS`` to all forum moderators.
        
        * *global posts* and *announcement* converted to normal sticky posts
        
        * sub forums would be flatten
        
        * *ghost moved posts* are ignored (only the moved post would be created)
        
        TODOs:
        
        * convert subscriptions
        
        open questions
        --------------
        
        * Are the phpBB times in ``phpbb_posts`` in UTC oder in local time from user?
        
        ------------
        phpBB3 links
        ------------
        
        Here some links for phpBB documentations:
        
        * `http://wiki.phpbb.com/Tables <http://wiki.phpbb.com/Tables>`_
        
        * `http://www.phpbbdoctor.com/doc_tables.php <http://www.phpbbdoctor.com/doc_tables.php>`_
        
        The SQL schema files from phpBB can be found here:
        
        * `https://github.com/phpbb/phpbb3/tree/develop/phpBB/install/schemas <https://github.com/phpbb/phpbb3/tree/develop/phpBB/install/schemas>`_
        
        -------------
        Project links
        -------------
        
        +--------------+-------------------------------------------+
        | Homepage     | `https://github.com/jedie/django-phpBB3`_ |
        +--------------+-------------------------------------------+
        | IRC          | `#pylucid on freenode.net`_               |
        +--------------+-------------------------------------------+
        | Forum Thread | `http://support.djangobb.org/topic/300/`_ |
        +--------------+-------------------------------------------+
        
        .. _https://github.com/jedie/django-phpBB3: https://github.com/jedie/django-phpBB3
        .. _#pylucid on freenode.net: http://www.pylucid.org/permalink/304/irc-channel
        .. _http://support.djangobb.org/topic/300/: http://support.djangobb.org/topic/300/
Keywords: django,forum,phpBB3,phpBB
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python
Classifier: Framework :: Django
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Documentation
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Operating System :: OS Independent
