Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Fix installation documentation

Roland Geider360c6ca08315
diff --git a/README.rst b/README.rst
index e0efc9bfc..855e29c79 100644
--- a/README.rst
+++ b/README.rst
@@ -66,12 +66,13 @@ Then install the python packages from pypi in the virtualenv::
$ git clone https://github.com/wger-project/wger.git
$ cd wger
$ pip install -r requirements.txt # or requirements_devel.txt to develop
- $ invoke create_settings \
- --settings-path /home/wger/wger/settings.py \
- --database-path /home/wger/wger/database.sqlite
- $ invoke bootstrap \
- --settings-path /home/wger/wger/settings.py \
- --no-start-server
+ $ python setup.py develop
+ $ wger create_settings \
+ --settings-path /home/wger/wger/settings.py \
+ --database-path /home/wger/wger/database.sqlite
+ $ wger bootstrap \
+ --settings-path /home/wger/wger/settings.py \
+ --no-start-server
$ python manage.py runserver
3) Log in as: **admin**, password **admin**
@@ -138,19 +139,20 @@ Stable version (from PyPI)
Command line options
--------------------
+You can get a list of all available commands by calling ``wger`` without any
+arguments::
-The available options for the ``wger`` command (if installed from PyPI) or
-``invoke`` (if installed from source) are the following (use e.g. ``wger
-<command>``::
+ Available tasks:
+ bootstrap 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 Start the application using django's built in webserver
- bootstrap 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 Start the application using django's built in webserver
+You can also get help on a specific command with ``wger --help <command>``.
Contact
=======
diff --git a/docs/commands.rst b/docs/commands.rst
index bda86bb25..f8b956a16 100644
--- a/docs/commands.rst
+++ b/docs/commands.rst
@@ -8,23 +8,14 @@ running application (to e.g. delete guest users, send emails, etc.).
Administration Commands
-----------------------
-The application provides several administration and bootstraping commands. They
-are all available with ``wger`` (if installed from PyPI) or ``invoke`` (if
-installed from source)::
+The application provides several administration and bootstraping commands that
+can be passed to the ``wger`` command::
wger <command>
-or ::
- invoke <command>
-
-Both versions behave the same but for simplicity, the invoke version will be used
-in this manual.
-
-
-You can get a list of all available commands with ``invoke --list`` or ``wger``.
-While you can do this from any folder in the application, some of them (e.g.
-``start``) might only work from the root folder::
+You can get a list of all available commands by calling ``wger`` without any
+arguments::
Available tasks:
@@ -36,14 +27,14 @@ While you can do this from any folder in the application, some of them (e.g.
migrate_db Run all database migrations
start Start the application using django's built in webserver
-You can also get help on a specific command with ``invoke --help <command>``.
+You can also get help on a specific command with ``wger --help <command>``.
.. 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 --settings-path /path/to/development/wger/settings-test.py
+ wger bootstrap --settings-path /path/to/development/wger/settings-test.py
@@ -57,7 +48,7 @@ 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 bootstrap
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
@@ -85,7 +76,7 @@ Command: **start**
Starts an already installed application::
- invoke start
+ wger start
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
@@ -126,11 +117,11 @@ 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
+ wger 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
+ wger create_settings --settings-path /path/to/development/wger/settings-test.py --database-path /path/to/development/wger/database-test.sqlite
Usage::
diff --git a/docs/development.rst b/docs/development.rst
index 1c37ad27b..2a06e56b7 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -29,6 +29,7 @@ Install Requirements
To install the Python requirements::
$ pip install -r requirements_devel.txt
+ $ python setup.py develop
Install NodeJS and npm::
Follow the instructions on the `NPM website <https://docs.npmjs
@@ -45,10 +46,10 @@ Install site
To install the server::
- $ invoke create_settings \
+ $ wger create_settings \
--settings-path /home/wger/wger/settings.py \
--database-path /home/wger/wger/database.sqlite
- $ invoke bootstrap \
+ $ wger bootstrap \
--settings-path /home/wger/wger/settings.py \
--no-start-server
diff --git a/docs/production.rst b/docs/production.rst
index 6859526de..1b91eb391 100644
--- a/docs/production.rst
+++ b/docs/production.rst
@@ -113,8 +113,9 @@ Get the application::
cd /home/wger/src
npm install bower
pip install -r requirements.txt
+ python setup.py develop
pip install psycopg2 # Only if using postgres
- invoke create_settings \
+ wger create_settings \
--settings-path /home/wger/src/settings.py \
--database-path /home/wger/db/database.sqlite
@@ -126,7 +127,7 @@ for the engine). Also set ``MEDIA_ROOT`` to ``/home/wger/media`` and
Run the installation script, this will download some CSS and JS libraries and
load all initial data::
- invoke bootstrap --settings-path /path/to/settings.py --no-start-server
+ wger bootstrap --settings-path /path/to/settings.py --no-start-server
Collect all static resources::