Merge pull request #63 from tracim/fix/better_readme

.gitignore

@@ -60,6 +60,7 @@ wsgidav.conf
 *~
 *.sqlite
 *.lock
+depot/
 
 # binary translation files
 *.mo

README.md

@@ -14,20 +14,23 @@ Installation
 
 ### Distribution dependencies ###
 
-on Debian Stretch (9) :
+on Debian Stretch (9) with sudo:
 
+    sudo apt update
     sudo apt install git
-    sudo apt install python3 python-virtualenv python3-dev python-pip
+    sudo apt install python3 python3-venv python3-dev python3-pip
 
 ### Get the source ###
 
+get source from github:
+
     git clone https://github.com/tracim/tracim_backend.git
 
-### Setup Python Virtualenv ###
+go to *tracim_backend* directory:
 
-Go to *tracim* subdirectory:
+    cd tracim_backend
 
-    cd tracim
+### Setup Python Virtualenv ###
 
 Create a Python virtual environment:
 
@@ -64,7 +67,7 @@ For mySQL:
 
 Create [configuration file](doc/setting.md) for a development environment:
 
-    cp development.ini.base development.ini
+    cp development.ini.sample development.ini
 
 Initialize the database using [tracimcli](doc/cli.md) tool
 
@@ -76,6 +79,16 @@ Run your project:
 
     pserve development.ini
 
+### Configure and Run Webdav Server (Unstable) ###
+
+create wsgidav configuration file :
+
+    cp wsgidav.conf.sample wsgidav.conf
+
+run wsgidav server:
+
+    tracimcli webdav start
+
 ### Run Tests and others checks ###
 
 Run your project's tests:

doc/cli.md

@@ -1,4 +1,4 @@
-## TracimCli ##
+# TracimCli #
 
 Tracim has a build-in command line tool.
 
@@ -6,18 +6,27 @@ Tracim has a build-in command line tool.
 
 This document is intended to developers or sysadmin.
 
-In order to use the `tracimcli` commands, change your current directory to be `tracim/` from the root of the project, also usually named `tracim/` 
+In order to use the `tracimcli` commands, go to the root of the project and
 and active the Tracim virtualenv:
 
-    user@host:~/tracim_backend$ cd tracim/
-    user@host:~/tracim_backend/tracim$ source env/bin/activate
-    (env) user@host:~/tracim_backend/tracim$
+    user@host:~/tracim_backend$ source env/bin/activate
+    (env) user@host:~/tracim_backend$
 
 ## Database ##
 
 ### Create database
 
-    tracim db init
+    tracimcli db init
+
+### Create database with some default test data (many users, workspaces, etc…)
+
+    tracimcli db init --test-data
+
+### Delete database /!\
+
+This will drop all your database, be carefull !
+
+    tracimcli db delete --force
 
 ## User ##
    
@@ -38,6 +47,10 @@ and active the Tracim virtualenv:
 
     tracimcli -h
     
+## Run services ##
+
+### Webdav wsgidav server ###
 
+    tracimcli webdav start
 
 

doc/migration.md

@@ -6,12 +6,11 @@ This document is intended to developers.
 
 Migrations on `Tracim` lays on [`alembic`](http://alembic.zzzcomputing.com/en/latest/index.html) which is the migration tool dedicated to `SQLAlchemy`.
 
-In order to use the `alembic` commands, change your current directory to be `tracim/` from the root of the project, also usually named `tracim/` 
+In order to use the `tracimcli` commands, go to the root of the project and
 and active the Tracim virtualenv:
 
-    user@host:~/tracim_backend$ cd tracim/
-    user@host:~/tracim_backend/tracim$ source env/bin/activate
-    (env) user@host:~/tracim_backend/tracim$
+    user@host:~/tracim_backend$ source env/bin/activate
+    (env) user@host:~/tracim_backend$
 
 ## Migration howto - Overview ##
    

setup.py

@@ -98,7 +98,8 @@ setup(
             'test = tracim.command:TestTracimCommand',
             'user_create = tracim.command.user:CreateUserCommand',
             'user_update = tracim.command.user:UpdateUserCommand',
-            'db_init = tracim.command.initializedb:InitializeDBCommand',
+            'db_init = tracim.command.database:InitializeDBCommand',
+            'db_delete = tracim.command.database:DeleteDBCommand',
             'webdav start = tracim.command.webdav:WebdavRunnerCommand',
         ]
     },

tracim/command/database.py

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+import argparse
+
+import plaster_pastedeploy
+import transaction
+from depot.manager import DepotManager
+from pyramid.paster import (
+    get_appsettings,
+    setup_logging,
+    )
+
+from tracim import CFG
+from tracim.fixtures import FixturesLoader
+from tracim.fixtures.users_and_groups import Base as BaseFixture
+from tracim.fixtures.content import Content as ContentFixture
+from sqlalchemy.exc import IntegrityError
+from tracim.command import AppContextCommand
+from tracim.models.meta import DeclarativeBase
+from tracim.models import (
+    get_engine,
+    get_session_factory,
+    get_tm_session,
+    )
+
+
+class InitializeDBCommand(AppContextCommand):
+    auto_setup_context = False
+
+    def get_description(self) -> str:
+        return "Initialize database"
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--test-data",
+            help='Add some default data to database to make test',
+            dest='test_data',
+            required=False,
+            action='store_true',
+            default=False,
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        super(InitializeDBCommand, self).take_action(parsed_args)
+        config_uri = parsed_args.config_file
+        setup_logging(config_uri)
+        settings = get_appsettings(config_uri)
+        self._create_schema(settings)
+        self._populate_database(settings, add_test_data=parsed_args.test_data)
+
+    @classmethod
+    def _create_schema(
+            cls,
+            settings: plaster_pastedeploy.ConfigDict
+    ) -> None:
+        print("- Create Schemas of databases -")
+        engine = get_engine(settings)
+        DeclarativeBase.metadata.create_all(engine)
+
+    @classmethod
+    def _populate_database(
+            cls,
+            settings: plaster_pastedeploy.ConfigDict,
+            add_test_data: bool
+    ) -> None:
+        engine = get_engine(settings)
+        session_factory = get_session_factory(engine)
+        app_config = CFG(settings)
+        print("- Populate database with default data -")
+        with transaction.manager:
+            dbsession = get_tm_session(session_factory, transaction.manager)
+            try:
+                fixtures = [BaseFixture]
+                fixtures_loader = FixturesLoader(dbsession, app_config)
+                fixtures_loader.loads(fixtures)
+                transaction.commit()
+                if add_test_data:
+                    app_config.configure_filedepot()
+                    fixtures = [ContentFixture]
+                    fixtures_loader.loads(fixtures)
+                transaction.commit()
+                print("Database initialized.")
+            except IntegrityError:
+                print('Warning, there was a problem when adding default data'
+                      ', it may have already been added:')
+                import traceback
+                print(traceback.format_exc())
+                transaction.abort()
+                print('Database initialization failed')
+
+
+class DeleteDBCommand(AppContextCommand):
+    auto_setup_context = False
+
+    def get_description(self) -> str:
+        return "Delete database"
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--force",
+            help='force delete of database',
+            dest='force',
+            required=False,
+            action='store_true',
+            default=False,
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        super(DeleteDBCommand, self).take_action(parsed_args)
+        config_uri = parsed_args.config_file
+        setup_logging(config_uri)
+        settings = get_appsettings(config_uri)
+        engine = get_engine(settings)
+        app_config = CFG(settings)
+        app_config.configure_filedepot()
+
+        if parsed_args.force:
+            print('Database deletion begin.')
+            DeclarativeBase.metadata.drop_all(engine)
+            print('Database deletion done.')
+            print('Cleaning depot begin.')
+            depot = DepotManager.get()
+            depot_files = depot.list()
+            for file_ in depot_files:
+                depot.delete(file_)
+            print('Cleaning depot done.')
+        else:
+            print('Warning, You should use --force if you really want to'
+                  ' delete database.')

tracim/command/initializedb.py

@@ -1,73 +0,0 @@
-# -*- coding: utf-8 -*-
-import argparse
-
-import plaster_pastedeploy
-import transaction
-from pyramid.paster import (
-    get_appsettings,
-    setup_logging,
-    )
-
-from tracim import CFG
-from tracim.fixtures import FixturesLoader
-from tracim.fixtures.users_and_groups import Base as BaseFixture
-from sqlalchemy.exc import IntegrityError
-from tracim.command import AppContextCommand
-from tracim.models.meta import DeclarativeBase
-from tracim.models import (
-    get_engine,
-    get_session_factory,
-    get_tm_session,
-    )
-
-
-class InitializeDBCommand(AppContextCommand):
-    auto_setup_context = False
-
-    def get_description(self) -> str:
-        return "Initialize DB"
-
-    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
-        parser = super().get_parser(prog_name)
-        return parser
-
-    def take_action(self, parsed_args: argparse.Namespace) -> None:
-        super(InitializeDBCommand, self).take_action(parsed_args)
-        config_uri = parsed_args.config_file
-        setup_logging(config_uri)
-        settings = get_appsettings(config_uri)
-        self._create_schema(settings)
-        self._populate_database(settings)
-
-    @classmethod
-    def _create_schema(
-            cls,
-            settings: plaster_pastedeploy.ConfigDict
-    ) -> None:
-        print("- Create Schemas of databases -")
-        engine = get_engine(settings)
-        DeclarativeBase.metadata.create_all(engine)
-
-    @classmethod
-    def _populate_database(
-            cls,
-            settings: plaster_pastedeploy.ConfigDict
-    ) -> None:
-        engine = get_engine(settings)
-        session_factory = get_session_factory(engine)
-        app_config = CFG(settings)
-        print("- Populate database with default data -")
-        with transaction.manager:
-            dbsession = get_tm_session(session_factory, transaction.manager)
-            try:
-                fixtures_loader = FixturesLoader(dbsession, app_config)
-                fixtures_loader.loads([BaseFixture])
-                transaction.commit()
-                print("Database initialized.")
-            except IntegrityError:
-                print('Warning, there was a problem when adding default data'
-                      ', it may have already been added:')
-                import traceback
-                print(traceback.format_exc())
-                transaction.abort()
-                print('Database initialization failed')

tracim/tests/__init__.py

@@ -5,7 +5,7 @@ from depot.manager import DepotManager
 from pyramid import testing
 from sqlalchemy.exc import IntegrityError
 
-from tracim.command.initializedb import InitializeDBCommand
+from tracim.command.database import InitializeDBCommand
 from tracim.lib.core.content import ContentApi
 from tracim.lib.core.workspace import WorkspaceApi
 from tracim.models import get_engine, DeclarativeBase, get_session_factory, \

tracim/tests/commands/test_commands.py

@@ -19,3 +19,4 @@ class TestCommands(object):
         assert output.find('user create') > 0
         assert output.find('user update') > 0
         assert output.find('db init') > 0
+        assert output.find('db delete') > 0

wsgidav.conf.sample

@@ -0,0 +1,38 @@
+################################################################################
+# Sample WsgiDAV configuration file
+#
+# 1. Rename this file to `wsgidav.conf`
+# 2. Adjust settings as appropriate
+# 3. Run tracim as you always do :)
+#
+################################################################################
+
+################################################################################
+# SERVER OPTIONS
+#===============================================================================
+
+
+# host  = "localhost"
+# host  = "192.168.0.1"
+host  = "0.0.0.0"
+
+port = 3030
+
+show_history = True
+show_deleted = True
+show_archived = True
+
+manager_locks = True
+
+root_path = ''
+
+# Tracim doesn't support digest auth for webdav
+acceptbasic = True
+acceptdigest = False
+defaultdigest = False
+#===============================================================================
+# Lock Manager
+#
+# Example: Use PERSISTENT shelve based lock manager
+#from wsgidav.lock_storage import LockStorageShelve
+#locksmanager = LockStorageShelve("wsgidav-locks.shelve")