Self hosted FLOSS fitness/workout, nutrition and weight tracker
New documentation page for the invoke commands
Roland Geiderd862175aaa4a
diff --git a/README.rst b/README.rstindex d823bc2aa..9ea8af330 100644--- a/README.rst+++ b/README.rst@@ -18,7 +18,8 @@ Installation============These are the basic steps to install and run the application locally on a linux-system.+system. Please consult the documentation for further information and parameters+on the invoke command.Development version (from git)@@ -44,13 +45,14 @@ state.$ git clone https://github.com/rolandgeider/wger.git$ cd wger$ pip install -r requirements.txt # or requirements_devel.txt to develop- $ python start.py+ $ invoke bootstrap_wger# After the first run you can just use django's development server$ python manage.py runserver3) Log in as: **admin**, password **admin**+Stable version (from PyPI)--------------------------@@ -69,7 +71,7 @@ Stable version (from PyPI)::- $ wger+ $ TODO TODO TODO TODO TODO3) Log in as: **admin**, password **admin**@@ -78,27 +80,17 @@ Stable version (from PyPI)Command line options---------------------The available options for the ``wger`` command (if installed from PyPI) or-``start.py`` (if installed from source) are the following ::-- Usage: main.py [options]-- Run wger Workout Manager using django's builtin server-- Options:- -h, --help show this help message and exit- -a ADDRESS, --address=ADDRESS- IP Address to listen on.- -p PORT, --port=PORT Port to listen on.- --syncdb Update/create database before starting the server.- --reset-admin Make sure the user 'admin' exists and uses 'admin' as- password.- -s SETTINGS, --settings=SETTINGS- Path to the wger configuration file.- --no-reload Do not reload the development server.- --no-browser Do not open the application in a browser.- --version Show version and exit.- --show-config Show configuration paths and exit.+The available options for the ``TODO`` command (if installed from PyPI) or+``invoke <command>`` (if installed from source) are the following ::+++ bootstrap_wger Performs all steps necessary to bootstrap the application+ config_location Returns the default location for the settings file and the data folder+ create_or_reset_admin Creates an admin user or resets the password for an existing one+ create_settings Creates a local settings file+ load_fixtures Loads all fixtures+ migrate_db Run all database migrations+ start_wger Start the application using django's built in webserverContact=======diff --git a/docs/index.rst b/docs/index.rstindex c07ee8d5b..4257da3ff 100644--- a/docs/index.rst+++ b/docs/index.rst@@ -27,6 +27,7 @@ Installation and developmentdevelopmentinstallcommands+ invokei18ndiff --git a/docs/invoke.rst b/docs/invoke.rstnew file mode 100644index 000000000..17bd143a6--- /dev/null+++ b/docs/invoke.rst@@ -0,0 +1,212 @@+Administration Commands+=======================++The application provides several administration and bootstraping commands. They+are all available with ``invoke <command>``.+++.. note::+ Please note that these commands are+ different from the ones described in :doc:`commands` as that those are made+ to administer a running application while these ones are intented e.g. to+ bootstrap/install an application to a new system.++.. note::+ Most commands support a ``--settings-path`` command line option that sets the+ settings file to use for the operation. If you use it, it is recommended to+ use absolute paths, for example::++ invoke bootstrap_wger --settings-path /path/to/development/wger/settings-test.py++You can get a list of all available commands with ``invoke --list``. While you can+do this from any folder in the application, some of them (e.g. ``start_wger``)+might only work from the root folder::++ Available tasks:++ bootstrap_wger Performs all steps necessary to bootstrap the application+ config_location Returns the default location for the settings file and the data folder+ create_or_reset_admin Creates an admin user or resets the password for an existing one+ create_settings Creates a local settings file+ load_fixtures Loads all fixtures+ migrate_db Run all database migrations+ start_wger Start the application using django's built in webserver++You can also get help on a specific command with ``invoke --help <command>``+++Bootstrap wger+--------------++Command: **bootstrap_wger**++This command bootstraps the application: it creates a settings file, initialises+a sqlite database, loads all necessary fixtures for the application to work and+creates a default administrator user. While it can also work with e.g. a postgreSQL+database, you will need to create it yourself::++ invoke bootstrap_wger++The most usual use-case is creating the settings file and the sqlite database to+their default locations, but you can set your own paths if you want e.g. start+developing on a branch that is going to change the database schema.++Usage::++ Usage: inv[oke] [--core-opts] bootstrap_wger [--options] [other tasks here ...]++ Docstring:+ Performs all steps necessary to bootstrap the application++ Options:+ -a STRING, --address=STRING Address to use. Default: localhost+ -b, --browser Whether to open the application in a browser window. Default: false+ -d STRING, --database-path=STRING Path to sqlite database (absolute path recommended). Leave empty for default+ -p, --port Port to use. Default: 8000+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default+++Start wger+----------++Command: **start_wger**++Starts an already installed application::++ invoke start_wger++Please note that this is simply a comfort function and does not use any *magic*,+it simply calls django's development server and (optionally) opens a browser+window. If you are developing, using the usual ``python manage.py runserver``+is probably better.++Usage::++ Usage: inv[oke] [--core-opts] start_wger [--options] [other tasks here ...]++ Docstring:+ Start the application using django's built in webserver++ Options:+ -a STRING, --address=STRING Address to bind to. Default: localhost+ -b, --browser Whether to open the application in a browser window. Default: false+ -e STRING, --extra-args=STRING Additional arguments to pass to the builtin server. Pass as string: "--arg1 --arg2=value". Default: none+ -p, --port Port to use. Default: 8000+ -s STRING, --settings-path=STRING Path to settings file. Leave empty for default+++Default locations+-----------------++Command: **config_location**++Information command that simply outputs the default locations for the settings+file as well as the data folder used for the sqlite database and the uploaded+files.+++Create settings+---------------++Command: **create_settings**++Creates a new settings file based. If you call it without further arguments it+will create the settings in the default locations::++ invoke create settings++If you pass custom paths, it's recommended to use absolute paths::++ invoke create_settings --settings-path /path/to/development/wger/settings-test.py --database-path /path/to/development/wger/database-test.sqlite+++Usage::++ Usage: inv[oke] [--core-opts] create_settings [--options] [other tasks here ...]++ Docstring:+ Creates a local settings file++ Options:+ -a STRING, --database-type=STRING Database type to use. Supported: sqlite3, postgresql. Default: sqlite3+ -d STRING, --database-path=STRING Path to sqlite database (absolute path recommended). Leave empty for default+ -k, --key-length Lenght of the generated secret key. Default: 30+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default+ -u STRING, --url=STRING++++Create or reset admin+---------------------++Command: **create_or_reset_admin**++Makes sure that the default administrator user exists. If you change the password+it is reset.+++Usage::++ Usage: inv[oke] [--core-opts] create_or_reset_admin [--options] [other tasks here ...]++ Docstring:+ Creates an admin user or resets the password for an existing one++ Options:+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default++++Migrate database+----------------++Command: **migrate_db**++Migrates the database schema. This command is called internally when installing+the application. The only need to call this explicitly is after installing a new+version of the application.++Calling this command is a safe operation, if your database is current, nothing+will happen.+++Usage::++ Usage: inv[oke] [--core-opts] migrate_db [--options] [other tasks here ...]++ Docstring:+ Run all database migrations++ Options:+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default++++Load all fixtures+-----------------++Command: **load_fixtures**++Loads all fixture file with the default data. This data includes all data necessary+for the application to work such as:++* exercises, muscles, equipment+* ingredients, units+* languages+* permission groups+* etc.++This command is called internally when installing the application but you can use+it to reset the data to the original state. Note: new entries or user entries such+as workouts are *not* reset with this, only the application data.++Usage::++ Usage: inv[oke] [--core-opts] load_fixtures [--options] [other tasks here ...]++ Docstring:+ Loads all fixtures++ Options:+ -s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default+