gvapgsql/docs/install.rst

37 lines
845 B
ReStructuredText
Raw Normal View History

2015-01-08 20:30:57 +01:00
.. index:: installation
=======
Install
=======
Working Environment
===================
2020-03-04 17:55:03 +01:00
To get a running work environment use `pipenv`_.
2015-01-08 20:30:57 +01:00
2020-03-04 17:55:03 +01:00
.. _pipenv: https://pipenv.kennethreitz.org/en/latest/
2015-01-08 20:30:57 +01:00
2020-03-04 17:55:03 +01:00
To get started install `pip` and `pipenv` and use `pipenv install --dev`:
2015-01-08 20:30:57 +01:00
.. code-block:: sh
2020-03-04 17:55:03 +01:00
$ apt install python3-pip
$ python3 -m pip install --user -U pipenv
$ pipenv install --dev
2015-01-08 20:30:57 +01:00
.. index:: celery, worker, file queue
Running the Celery worker
=========================
gvapgsql uses the `Celery`_ distributed task queue system. The gvapgsql logic is
executed by a celery worker. After all dependencies are installed you can go
into the gvapgsql directory and run the celery worker with:
.. code-block:: sh
$ cd gvapgsql
2020-03-04 17:55:03 +01:00
$ pipenv run celery -A pgsqltasks worker -Q web -l info
2015-01-08 20:30:57 +01:00
.. _Celery: http://www.celeryproject.org/