Modernize the meta files of the project
All checks were successful
Run tests / Execute tox to run the test suite (push) Successful in 2m40s
All checks were successful
Run tests / Execute tox to run the test suite (push) Successful in 2m40s
This commit is contained in:
31
INSTALL.rst
31
INSTALL.rst
@@ -1,12 +1,11 @@
|
||||
REQUIREMENTS
|
||||
============
|
||||
- Python 3
|
||||
- Python package virtualenv (in most cases this is distributed or installed together with python)
|
||||
- Django (will be installed automatically)
|
||||
- Several additional django related python packages (will be installed automatically)
|
||||
- Python >= 3
|
||||
- Django and some other python packages, that will be installed throughout
|
||||
the installation process
|
||||
|
||||
For production use you surly want a real web server that supports WSGI
|
||||
(e.g. Apache httpd with mod_wsgi) and a real Database like PostgreSQL.
|
||||
(e.g. Apache httpd with mod_wsgi) and a real Database like PostgreSQL (psycopg2).
|
||||
|
||||
|
||||
QUICK INSTALLATION FOR THE IMPATIENT
|
||||
@@ -24,14 +23,11 @@ INSTALLATION
|
||||
It is strongly recommended to create a separated python environment
|
||||
for this django project. But it is not exactly necessary.
|
||||
|
||||
The creation of a separated python environment is very easy with the
|
||||
virtualenv tool (a python package).
|
||||
|
||||
If you decide to not use virtualenv, proceed with step 2.
|
||||
|
||||
- Create the python environment in a directory called ./env/python:
|
||||
|
||||
``virtualenv --prompt="(dav)" ./env/python``
|
||||
``python -m venv --prompt="(dav)" ./env/python``
|
||||
|
||||
- If you use a posix compatible shell (like bash, the linux default shell),
|
||||
you have to activate the environment for the current shell session
|
||||
@@ -50,16 +46,25 @@ If you have left the session or deactivated the environment and want to
|
||||
reactivate the environment (e.g. to execute a python command) use the
|
||||
previous ``source ...`` command.
|
||||
|
||||
2. Install files
|
||||
----------------
|
||||
2. Install requirements
|
||||
-----------------------
|
||||
|
||||
- ``python -m pip install -r requirements.txt``
|
||||
|
||||
3. Install project code in development mode
|
||||
-------------------------------------------
|
||||
|
||||
- ``python -m pip install -e .``
|
||||
|
||||
4. Setup django project directory
|
||||
---------------------------------
|
||||
|
||||
- ``python setup.py develop``
|
||||
- ``django-dav-events-admin setup ./env/django``
|
||||
|
||||
The django project directory ('./env/django' within the previous example)
|
||||
will be called *project root* for now on.
|
||||
|
||||
3. Enable modules
|
||||
5. Enable modules
|
||||
-----------------
|
||||
Our web application consist of several modules, that care about single
|
||||
aspects of the whole picture.
|
||||
|
||||
Reference in New Issue
Block a user