~homeworkprod/byceps

82a68bb6c7da7431b887abad8ef3754d7fafa6f2 — Jochen Kupperschmidt 2 years ago 9771364
Update documentation regarding installation in editable mode
2 files changed, 14 insertions(+), 4 deletions(-)

M docs/installation.rst
M scripts/README.txt
M docs/installation.rst => docs/installation.rst +10 -3
@@ 116,6 116,13 @@ Install the Python depdendencies via pip_:

    (venv)$ pip install -r requirements.txt

Install BYCEPS in editable mode to make ``import byceps`` work in
scripts:

.. code-block:: sh

    (venv)$ pip install -e .

.. _dot command: https://en.wikipedia.org/wiki/Dot_(Unix)




@@ 204,7 211,7 @@ Create the necessary tables:

.. code-block:: sh

   $ PYTHONPATH=.. BYCEPS_CONFIG=../config/yourconfig.py ./create_database_tables.py
   $ BYCEPS_CONFIG=../config/yourconfig.py ./create_database_tables.py
   Creating database tables ... done.

An initial set of authorization permissions and roles is provided as a


@@ 212,7 219,7 @@ JSON file. Import it into the database:

.. code-block:: sh

   $ PYTHONPATH=.. BYCEPS_CONFIG=../config/yourconfig.py ./import_permissions_and_roles.py data/permissions_and_roles.json
   $ BYCEPS_CONFIG=../config/yourconfig.py ./import_permissions_and_roles.py data/permissions_and_roles.json
   Importing 75 permissions ... done.
   Importing 29 roles ... done.



@@ 221,7 228,7 @@ will get all available roles assigned):

.. code-block:: sh

   $ PYTHONPATH=.. BYCEPS_CONFIG=../config/yourconfig.py ./create_initial_admin_user.py
   $ BYCEPS_CONFIG=../config/yourconfig.py ./create_initial_admin_user.py
   Screen name: Flynn
   Email address: flynn@flynns-arcade.net
   Password:

M scripts/README.txt => scripts/README.txt +4 -1
@@ 1,3 1,6 @@
To execute a script from this folder, call it like this:

    $ PYTHONPATH=.. BYCEPS_CONFIG=../config/someparty-staging.py ./create_some_stuff.py
    $ BYCEPS_CONFIG=../config/someparty-staging.py ./create_some_stuff.py

Make sure that the virtual environment is active and that BYCEPS has
been installed in editable mode (see documentation on installation).