Skip to content
This repository has been archived by the owner on Oct 5, 2021. It is now read-only.

Commit

Permalink
upd doc and editor settings
Browse files Browse the repository at this point in the history
  • Loading branch information
FoxMaSk committed Oct 26, 2017
1 parent e8b1fb6 commit 2c45772
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 38 deletions.
5 changes: 4 additions & 1 deletion .editorconfig
Expand Up @@ -14,7 +14,7 @@ indent_size = 4

[*.py]
line_length=120
known_first_party={{ cookiecutter.project_slug }}
known_first_party=django_th
multi_line_output=3
default_section=THIRDPARTY

Expand All @@ -31,3 +31,6 @@ indent_style = tab
[nginx.conf]
indent_style = space
indent_size = 2

[Dockerfile]
indent_size = 4
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -20,3 +20,4 @@ build
th_tox
django_th/.env
docs/_build
htmlcov
4 changes: 2 additions & 2 deletions .pylintrc
@@ -1,4 +1,4 @@
MASTER]
[MASTER]
load-plugins=pylint_common, pylint_django

[FORMAT]
Expand All @@ -11,4 +11,4 @@ disable=missing-docstring,invalid-name
max-parents=13

[TYPECHECK]
generated-members=REQUEST,acl_users,aq_parent,"[a-zA-Z]+_set{1,2}",save,delete
generated-members=REQUEST,acl_users,aq_parent,"[a-zA-Z]+_set{1,2}",save,delete
34 changes: 0 additions & 34 deletions README_docker.md

This file was deleted.

58 changes: 58 additions & 0 deletions docs/docker_guide/index.rst
@@ -0,0 +1,58 @@
.. _docker:

Docker Guide
============

The docker file is based on `build <https://docs.docker.com/engine/reference/commandline/build/>`_ and
`compose <https://docs.docker.com/compose/django/>`_ and a bit of `django hub <https://hub.docker.com/_/django/>`_

Build
-----

The first time you use the docker image of trigger happy, launch this command to build the image.

This won't be necessary for the next time

.. code-block:: bash
docker-compose build
Run
---

This is necessary each time you want to use Trigger Happy

.. code-block:: bash
docker-compose up
Database update/create
----------------------

This is necessary the first time, after building the docker image done above.

.. code-block:: bash
docker-compose run web python manage.py migrate --settings=django_th.settings_docker
docker-compose run web python manage.py initial_services --settings=django_th.settings_docker
docker-compose run web python manage.py createsuperuser --settings=django_th.settings_docker
This is necessary only when a new release of Trigger Happy is done

.. code-block:: bash
docker-compose run web python manage.py migrate --settings=django_th.settings_docker
Running tasks
-------------

2 tasks are usually in the crontab: one to read the data source, one to publish the grabbed data:

.. code-block:: bash
docker-compose run web python manage.py read --settings=django_th.settings_docker
docker-compose run web python manage.py publish --settings=django_th.settings_docker
9 changes: 9 additions & 0 deletions docs/index.rst
Expand Up @@ -103,3 +103,12 @@ The Administration Guide
:maxdepth: 2

admin_guide/index


The Docker Guide
-----------------

.. toctree::
:maxdepth: 2

docker_guide/index
2 changes: 1 addition & 1 deletion setup.cfg
@@ -1,4 +1,4 @@
[flake8]
max-line-length=80
max-line-length=120
exclude=migrations,*settings*.py,feedsservice,.tox,build,from_*

0 comments on commit 2c45772

Please sign in to comment.