Skip to content

Commit

Permalink
Updates documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Kouhei Maeda <mkouhei@palmtb.net>
  • Loading branch information
mkouhei committed Jun 19, 2015
1 parent e1331ef commit 66e867d
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 41 deletions.
41 changes: 0 additions & 41 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,3 @@ Status
:target: https://readthedocs.org/projects/pgraph/?badge=latest
:alt: Documentation Status

How to run things locally
=========================

1. Installing RabbitMQ.::

$ sudo apt-get install rabbitmq-server

2. Setup RabbitMQ.::

$ sudo rabbitmqctl add_vhost /pgraph
$ sudo rabbitmqctl add_user pgraph passw0rd
$ sudo rabbitmqctl set_permissions -p /pgraph pgraph ".*" ".*" ".*"
$ sudo rabbitmqctl delete_user guest

3. Cloning repository.::

$ git clone https://github.com/mkouhei/pgraph
$ cd pgraph
$ git submodule init
$ git submodule update

4. Createing virtual environment.::

$ pyvenv /path/to/venv
$ . /path/to/venv/bin/activate

5. Installing pgraph.::
(venv)$ cd /path/to/pgraph
(venv)$ python setup.py install
or
(venv)$ pip install --egg pgraph

6. Running celery worker.::

(venv)$ CELERY_CONFIG=/path/to/pgraph/development.ini celery -A pgraph.tasks worker --loglevel=info

7. Running pserve from another venv session.::

(venv)$ pserve /path/to/pgraph/development.ini

1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Contents:
:maxdepth: 2

README
locally
heroku

.. toctree::
Expand Down
64 changes: 64 additions & 0 deletions docs/source/locally.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@

How to run things locally
=========================

1. Installing RabbitMQ.

.. code-block:: shell
$ sudo apt-get install rabbitmq-server
2. Setup RabbitMQ.

.. code-block:: shell
$ sudo rabbitmqctl add_vhost /pgraph
$ sudo rabbitmqctl add_user pgraph passw0rd
$ sudo rabbitmqctl set_permissions -p /pgraph pgraph ".*" ".*" ".*"
$ sudo rabbitmqctl delete_user guest
3. Cloning repository.

.. code-block:: shell
$ git clone https://github.com/mkouhei/pgraph
$ cd pgraph
$ git submodule init
$ git submodule update
4. Createing virtual environment.

.. code-block:: shell
$ pyvenv /path/to/venv
$ . /path/to/venv/bin/activate
5. Installing pgraph.

.. code-block:: shell
(venv)$ cd /path/to/pgraph
(venv)$ python setup.py install
or

.. code-block:: shell
(venv)$ easy_install pgraph
.. warning::
Not use ``pip install pgraph``. See also "`Known issue with the packages that depends on py-deps <http://py-deps.readthedocs.org/en/latest/README.html#known-issue-with-the-packages-that-depends-on-py-deps>`_".


6. Running celery worker.

.. code-block:: shell
(venv)$ CELERY_CONFIG=/path/to/pgraph/development.ini celery -A pgraph.tasks worker --loglevel=info
7. Running pserve from another venv session.

.. code-block:: shell
(venv)$ pserve /path/to/pgraph/development.ini

0 comments on commit 66e867d

Please sign in to comment.