Skip to content

Commit

Permalink
Added Click installation hints.
Browse files Browse the repository at this point in the history
  • Loading branch information
idlesign committed Nov 11, 2018
1 parent 512398d commit ef42bf8
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 3 deletions.
4 changes: 3 additions & 1 deletion INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ Alternatively you can install ``uwsgiconf`` from PyPI:

pip install uwsgiconf

; Install with Click package for CLI:
pip install uwsgiconf[cli]


Use `-U` flag for upgrade:

pip install -U uwsgiconf

2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Let's make ``uwsgicfg.py``. There we configure uWSGI using nice ``PythonSection`
$ uwsgiconf run
**Note:** ``uwsgiconf`` CLI requires ``click`` package available.
**Note:** ``uwsgiconf`` CLI requires ``click`` package available (can be installed with ``uwsgiconf``).


Runtime configuration
Expand Down
5 changes: 5 additions & 0 deletions docs/source/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ Command-line interface (CLI)

**uwsgiconf** comes with CLI (``click`` package required) to facilitate configuration.

.. code-block:: bash
; To install uwsgiconf with click:
$ pip install uwsgiconf[cli]
Compile
-------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index_contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ runuwsgi
Now your project is up and running on ``http://127.0.0.1:8000``.

By default the command runs your project using some defaults, but you can configure it to your needs
with the help of ``uwsgicfg.py`` (constructed in a usual for ``uwsgiconf`` manner) placed near your ``manage.py``.
with the help of ``uwsgicfg.py`` (constructed in a usual for **uwsgiconf** manner) placed near your ``manage.py``.


.. code-block:: python
Expand Down

0 comments on commit ef42bf8

Please sign in to comment.