mirror of
https://github.com/jazzband/django-celery-monitor.git
synced 2026-03-16 22:00:24 +00:00
More documentation fixes.
This commit is contained in:
Jannis Leidel
parent
7234b8546d
commit
ef10d27d0b
17 changed files with 127 additions and 502 deletions
8
LICENSE
8
LICENSE
|
|
@ -3,7 +3,7 @@ Copyright (c) 2015-2016 Ask Solem. All Rights Reserved.
|
|||
Copyright (c) 2012-2014 GoPivotal, Inc. All Rights Reserved.
|
||||
Copyright (c) 2009-2012 Ask Solem. All Rights Reserved.
|
||||
|
||||
django-celery-monitor is licensed under The BSD License (3 Clause, also known as
|
||||
django_celery_monitor is licensed under The BSD License (3 Clause, also known as
|
||||
the new BSD license). The license is an OSI approved Open Source
|
||||
license and is GPL-compatible(1).
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ POSSIBILITY OF SUCH DAMAGE.
|
|||
Documentation License
|
||||
=====================
|
||||
|
||||
The documentation portion of django-celery-monitor (the rendered contents of the
|
||||
The documentation portion of django_celery_monitor (the rendered contents of the
|
||||
"docs" directory of a software distribution or checkout) is supplied
|
||||
under the "Creative Commons Attribution-ShareAlike 4.0
|
||||
International" (CC BY-SA 4.0) License as described by
|
||||
|
|
@ -48,8 +48,8 @@ http://creativecommons.org/licenses/by-sa/4.0/
|
|||
Footnotes
|
||||
=========
|
||||
(1) A GPL-compatible license makes it possible to
|
||||
combine django-celery-monitor with other software that is released
|
||||
combine django_celery_monitor with other software that is released
|
||||
under the GPL, it does not mean that we're distributing
|
||||
django-celery-monitor under the GPL license. The BSD license, unlike the GPL,
|
||||
django_celery_monitor under the GPL license. The BSD license, unlike the GPL,
|
||||
let you distribute a modified version without making your
|
||||
changes open source.
|
||||
|
|
|
|||
32
Makefile
32
Makefile
|
|
@ -8,15 +8,10 @@ ICONV=iconv
|
|||
FLAKE8=flake8
|
||||
FLAKEPLUS=flakeplus
|
||||
PYDOCSTYLE=pydocstyle
|
||||
SPHINX2RST=sphinx2rst
|
||||
|
||||
TESTDIR=t
|
||||
SPHINX_DIR=docs/
|
||||
SPHINX_BUILDDIR="${SPHINX_DIR}/_build"
|
||||
README=README.rst
|
||||
README_SRC="docs/templates/readme.txt"
|
||||
CONTRIBUTING=CONTRIBUTING.rst
|
||||
CONTRIBUTING_SRC="docs/contributing.rst"
|
||||
SPHINX_HTMLDIR="${SPHINX_BUILDDIR}/html"
|
||||
DOCUMENTATION=Documentation
|
||||
FLAKEPLUSTARGET=2.7
|
||||
|
|
@ -31,14 +26,10 @@ help:
|
|||
@echo " lint ------------ - Check codebase for problems."
|
||||
@echo " apicheck - Check API reference coverage."
|
||||
@echo " configcheck - Check configuration reference coverage."
|
||||
@echo " readmecheck - Check README.rst encoding."
|
||||
@echo " contribcheck - Check CONTRIBUTING.rst encoding"
|
||||
@echo " flakes -------- - Check code for syntax and style errors."
|
||||
@echo " flakecheck - Run flake8 on the source code."
|
||||
@echo " flakepluscheck - Run flakeplus on the source code."
|
||||
@echo " pep257check - Run pydocstyle on the source code."
|
||||
@echo "readme - Regenerate README.rst file."
|
||||
@echo "contrib - Regenerate CONTRIBUTING.rst file"
|
||||
@echo "clean-dist --------- - Clean all distribution build artifacts."
|
||||
@echo " clean-git-force - Remove all uncomitted files."
|
||||
@echo " clean ------------ - Non-destructive clean"
|
||||
|
|
@ -75,7 +66,7 @@ docs: Documentation
|
|||
clean-docs:
|
||||
-rm -rf "$(SPHINX_BUILDDIR)"
|
||||
|
||||
lint: flakecheck apicheck configcheck readmecheck
|
||||
lint: flakecheck apicheck configcheck
|
||||
|
||||
apicheck:
|
||||
(cd "$(SPHINX_DIR)"; $(MAKE) apicheck)
|
||||
|
|
@ -100,25 +91,6 @@ flakeplusdiag:
|
|||
|
||||
flakes: flakediag flakeplusdiag pep257check
|
||||
|
||||
clean-readme:
|
||||
-rm -f $(README)
|
||||
|
||||
readmecheck:
|
||||
$(ICONV) -f ascii -t ascii $(README) >/dev/null
|
||||
|
||||
$(README):
|
||||
$(SPHINX2RST) "$(README_SRC)" --ascii > $@
|
||||
|
||||
readme: clean-readme $(README) readmecheck
|
||||
|
||||
clean-contrib:
|
||||
-rm -f "$(CONTRIBUTING)"
|
||||
|
||||
$(CONTRIBUTING):
|
||||
$(SPHINX2RST) "$(CONTRIBUTING_SRC)" > $@
|
||||
|
||||
contrib: clean-contrib $(CONTRIBUTING)
|
||||
|
||||
clean-pyc:
|
||||
-find . -type f -a \( -name "*.pyc" -o -name "*$$py.class" \) | xargs rm
|
||||
-find . -type d -name "__pycache__" | xargs rm -r
|
||||
|
|
@ -145,4 +117,4 @@ build:
|
|||
|
||||
distcheck: lint test clean
|
||||
|
||||
dist: readme contrib clean-dist build
|
||||
dist: clean-dist build
|
||||
|
|
|
|||
140
README.rst
140
README.rst
|
|
@ -1,15 +1,15 @@
|
|||
================================================
|
||||
Celery Monitor for the Django admin framework.
|
||||
================================================
|
||||
|
||||
|build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
|
||||
============================
|
||||
Celery Monitoring for Django
|
||||
============================
|
||||
|
||||
:Version: 1.0.0
|
||||
:Web: http://django-celery-monitor.readthedocs.io/
|
||||
:Download: http://pypi.python.org/pypi/django-celery-monitor
|
||||
:Source: http://github.com/jezdez/django-celery-monitor
|
||||
:Web: https://django-celery-monitor.readthedocs.io/
|
||||
:Download: https://pypi.python.org/pypi/django_celery_monitor
|
||||
:Source: https://github.com/jezdez/django-celery-monitor
|
||||
:Keywords: django, celery, events, monitoring
|
||||
|
||||
|build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
|
||||
|
||||
About
|
||||
=====
|
||||
|
||||
|
|
@ -22,6 +22,95 @@ It provides a Camera class (``django_celery_monitor.camera.Camera``) to be
|
|||
used with the Celery events command line tool to automatically populate the
|
||||
two models with the current state of the Celery workers and tasks.
|
||||
|
||||
History
|
||||
=======
|
||||
|
||||
This package is a Celery 4 compatible port of the Django admin based
|
||||
monitoring feature that was included in the old
|
||||
`django-celery <https://pypi.python.org/pypi/django-celery>`_ package which
|
||||
is only compatible with Celery < 4.0.
|
||||
Other parts of django-celery were released as
|
||||
`django-celery-beat <https://pypi.python.org/pypi/django_celery_beat>`_
|
||||
(Database-backed Periodic Tasks) and
|
||||
`django-celery-results <https://pypi.python.org/pypi/django_celery_results>`_
|
||||
(Celery result backends for Django).
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install django-celery-monitor either via the Python Package Index (PyPI)
|
||||
or from source.
|
||||
|
||||
To install using `pip`,:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install -U django-celery-monitor
|
||||
|
||||
.. _installing-from-source:
|
||||
|
||||
Downloading and installing from source
|
||||
--------------------------------------
|
||||
|
||||
Download the latest version of django-celery-monitor from
|
||||
http://pypi.python.org/pypi/django_celery_monitor
|
||||
|
||||
You can install it by doing the following,:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ tar xvfz django-celery-monitor-0.0.0.tar.gz
|
||||
$ cd django-celery-monitor-0.0.0
|
||||
$ python setup.py build
|
||||
# python setup.py install
|
||||
|
||||
The last command must be executed as a privileged user if
|
||||
you are not currently using a virtualenv.
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
To use this with your project you need to follow these steps:
|
||||
|
||||
#. Install the django_celery_monitor library:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install django_celery_monitor
|
||||
|
||||
#. Add ``django_celery_monitor`` to ``INSTALLED_APPS`` in your
|
||||
Django project's :file:`settings.py`::
|
||||
|
||||
INSTALLED_APPS = (
|
||||
...,
|
||||
'django_celery_monitor',
|
||||
)
|
||||
|
||||
Note that there is no dash in the module name, only underscores.
|
||||
|
||||
#. Create the Celery database tables by performing a database migrations:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python manage.py migrate django_celery_monitor
|
||||
|
||||
Starting the monitoring process
|
||||
===============================
|
||||
|
||||
To enable taking snapshots of the current state of tasks and workers you'll
|
||||
want to run the Celery events command with the appropriate camera class
|
||||
``django_celery_monitor.camera.Camera``:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ celery -A proj events -l info --camera django_celery_monitor.camera.Camera --frequency=2.0
|
||||
|
||||
For a complete listing of the command-line options available see:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ celery events --help
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
|
|
@ -52,35 +141,6 @@ In your Celery configuration simply set them to override the defaults, e.g.::
|
|||
|
||||
monitor_task_success_expires = timedelta(days=7)
|
||||
|
||||
.. _installation:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install django-celery-monitor either via the Python Package Index (PyPI)
|
||||
or from source.
|
||||
|
||||
To install using `pip`,::
|
||||
|
||||
$ pip install -U django-celery-monitor
|
||||
|
||||
.. _installing-from-source:
|
||||
|
||||
Downloading and installing from source
|
||||
--------------------------------------
|
||||
|
||||
Download the latest version of django-celery-monitor from
|
||||
http://pypi.python.org/pypi/django-celery-monitor
|
||||
|
||||
You can install it by doing the following,::
|
||||
|
||||
$ tar xvfz django-celery-monitor-0.0.0.tar.gz
|
||||
$ cd django-celery-monitor-0.0.0
|
||||
$ python setup.py build
|
||||
# python setup.py install
|
||||
|
||||
The last command must be executed as a privileged user if
|
||||
you are not currently using a virtualenv.
|
||||
|
||||
.. |build-status| image:: https://secure.travis-ci.org/jezdez/django-celery-monitor.svg?branch=master
|
||||
:alt: Build status
|
||||
|
|
@ -95,13 +155,13 @@ you are not currently using a virtualenv.
|
|||
|
||||
.. |wheel| image:: https://img.shields.io/pypi/wheel/django-celery-monitor.svg
|
||||
:alt: django-celery-monitor can be installed via wheel
|
||||
:target: http://pypi.python.org/pypi/django-celery-monitor/
|
||||
:target: http://pypi.python.org/pypi/django_celery_monitor/
|
||||
|
||||
.. |pyversion| image:: https://img.shields.io/pypi/pyversions/django-celery-monitor.svg
|
||||
:alt: Supported Python versions.
|
||||
:target: http://pypi.python.org/pypi/django-celery-monitor/
|
||||
:target: http://pypi.python.org/pypi/django_celery_monitor/
|
||||
|
||||
.. |pyimp| image:: https://img.shields.io/pypi/implementation/django-celery-monitor.svg
|
||||
:alt: Support Python implementations.
|
||||
:target: http://pypi.python.org/pypi/django-celery-monitor/
|
||||
:target: http://pypi.python.org/pypi/django_celery_monitor/
|
||||
|
||||
|
|
|
|||
|
|
@ -27,4 +27,5 @@ globals().update(conf.build_config(
|
|||
'django_celery_monitor.admin',
|
||||
r'django_celery_monitor.migrations.*',
|
||||
],
|
||||
suppress_warnings=['image.nonlocal_uri'],
|
||||
))
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
Copyright
|
||||
=========
|
||||
|
||||
*django-celery-monitor User Manual*
|
||||
*django_celery_monitor User Manual*
|
||||
|
||||
by Ask Solem and Jannis Leidel
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ Copyright |copy| 2016, Ask Solem
|
|||
All rights reserved. This material may be copied or distributed only
|
||||
subject to the terms and conditions set forth in the `Creative Commons
|
||||
Attribution-ShareAlike 4.0 International
|
||||
<http://creativecommons.org/licenses/by-sa/4.0/legalcode>`_ license.
|
||||
<https://creativecommons.org/licenses/by-sa/4.0/legalcode>`_ license.
|
||||
|
||||
You may share and adapt the material, even for commercial purposes, but
|
||||
you must give the original author credit.
|
||||
|
|
@ -23,7 +23,7 @@ a license compatible to this one.
|
|||
|
||||
.. note::
|
||||
|
||||
While the django-celery-monitor *documentation* is offered under the
|
||||
While the django_celery_monitor *documentation* is offered under the
|
||||
Creative Commons *Attribution-ShareAlike 4.0 International* license
|
||||
the django-celery-monitor *software* is offered under the
|
||||
`BSD License (3 Clause) <http://www.opensource.org/licenses/BSD-3-Clause>`_
|
||||
the django_celery_monitor *software* is offered under the
|
||||
`BSD License (3 Clause) <https://opensource.org/licenses/BSD-3-Clause>`_
|
||||
|
|
|
|||
|
|
@ -1,29 +0,0 @@
|
|||
.. _installation:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install django-celery-monitor either via the Python Package Index (PyPI)
|
||||
or from source.
|
||||
|
||||
To install using `pip`,::
|
||||
|
||||
$ pip install -U django-celery-monitor
|
||||
|
||||
.. _installing-from-source:
|
||||
|
||||
Downloading and installing from source
|
||||
--------------------------------------
|
||||
|
||||
Download the latest version of django-celery-monitor from
|
||||
http://pypi.python.org/pypi/django-celery-monitor
|
||||
|
||||
You can install it by doing the following,::
|
||||
|
||||
$ tar xvfz django-celery-monitor-0.0.0.tar.gz
|
||||
$ cd django-celery-monitor-0.0.0
|
||||
$ python setup.py build
|
||||
# python setup.py install
|
||||
|
||||
The last command must be executed as a privileged user if
|
||||
you are not currently using a virtualenv.
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
:Version: 1.0.0
|
||||
:Web: http://django-celery-monitor.readthedocs.io/
|
||||
:Download: http://pypi.python.org/pypi/django-celery-monitor
|
||||
:Source: http://github.com/jezdez/django-celery-monitor
|
||||
:Keywords: django, celery, events, monitoring
|
||||
|
||||
About
|
||||
=====
|
||||
|
||||
This extension enables you to monitor Celery tasks and workers.
|
||||
|
||||
It defines two models (``django_celery_monitor.models.WorkerState`` and
|
||||
``django_celery_monitor.models.TaskState``) used to store worker and task states
|
||||
and you can query this database table like any other Django model.
|
||||
It provides a Camera class (``django_celery_monitor.camera.Camera``) to be
|
||||
used with the Celery events command line tool to automatically populate the
|
||||
two models with the current state of the Celery workers and tasks.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
There are a few settings that regulate how long the task monitor should keep
|
||||
state entries in the database. Either of the three should be a
|
||||
``datetime.timedelta`` value or ``None``.
|
||||
|
||||
- ``monitor_task_success_expires`` -- Defaults to ``timedelta(days=1)`` (1 day)
|
||||
|
||||
The period of time to retain monitoring information about tasks with a
|
||||
``SUCCESS`` result.
|
||||
|
||||
- ``monitor_task_error_expires`` -- Defaults to ``timedelta(days=3)`` (3 days)
|
||||
|
||||
The period of time to retain monitoring information about tasks with an
|
||||
errornous result (one of the following event states: ``RETRY``, ``FAILURE``,
|
||||
``REVOKED``.
|
||||
|
||||
- ``monitor_task_pending_expires`` -- Defaults to ``timedelta(days=5)`` (5 days)
|
||||
|
||||
The period of time to retain monitoring information about tasks with a
|
||||
pending result (one of the following event states: ``PENDING``, ``RECEIVED``,
|
||||
``STARTED``, ``REJECTED``, ``RETRY``.
|
||||
|
||||
In your Celery configuration simply set them to override the defaults, e.g.::
|
||||
|
||||
from datetime import timedelta
|
||||
|
||||
monitor_task_success_expires = timedelta(days=7)
|
||||
|
|
@ -1,8 +1,4 @@
|
|||
======================================================
|
||||
django-celery-monitor - Celery Monitoring for Django
|
||||
======================================================
|
||||
|
||||
.. include:: includes/introduction.txt
|
||||
.. include:: ../README.rst
|
||||
|
||||
Contents
|
||||
========
|
||||
|
|
@ -21,11 +17,3 @@ Contents
|
|||
:maxdepth: 1
|
||||
|
||||
changelog
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
|
|||
272
docs/make.bat
272
docs/make.bat
|
|
@ -1,272 +0,0 @@
|
|||
@ECHO OFF
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set BUILDDIR=_build
|
||||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
|
||||
set I18NSPHINXOPTS=%SPHINXOPTS% .
|
||||
if NOT "%PAPER%" == "" (
|
||||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
||||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
||||
)
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
if "%1" == "help" (
|
||||
:help
|
||||
echo.Please use `make ^<target^>` where ^<target^> is one of
|
||||
echo. html to make standalone HTML files
|
||||
echo. dirhtml to make HTML files named index.html in directories
|
||||
echo. singlehtml to make a single large HTML file
|
||||
echo. pickle to make pickle files
|
||||
echo. json to make JSON files
|
||||
echo. htmlhelp to make HTML files and a HTML help project
|
||||
echo. qthelp to make HTML files and a qthelp project
|
||||
echo. devhelp to make HTML files and a Devhelp project
|
||||
echo. epub to make an epub
|
||||
echo. epub3 to make an epub3
|
||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||
echo. text to make text files
|
||||
echo. man to make manual pages
|
||||
echo. texinfo to make Texinfo files
|
||||
echo. gettext to make PO message catalogs
|
||||
echo. changes to make an overview over all changed/added/deprecated items
|
||||
echo. xml to make Docutils-native XML files
|
||||
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
||||
echo. linkcheck to check all external links for integrity
|
||||
echo. doctest to run all doctests embedded in the documentation if enabled
|
||||
echo. coverage to run coverage check of the documentation if enabled
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "clean" (
|
||||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
||||
del /q /s %BUILDDIR%\*
|
||||
goto end
|
||||
)
|
||||
|
||||
|
||||
REM Check if sphinx-build is available and fallback to Python version if any
|
||||
%SPHINXBUILD% 1>NUL 2>NUL
|
||||
if errorlevel 9009 goto sphinx_python
|
||||
goto sphinx_ok
|
||||
|
||||
:sphinx_python
|
||||
|
||||
set SPHINXBUILD=python -m sphinx.__init__
|
||||
%SPHINXBUILD% 2> nul
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:sphinx_ok
|
||||
|
||||
|
||||
if "%1" == "html" (
|
||||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "dirhtml" (
|
||||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "singlehtml" (
|
||||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pickle" (
|
||||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the pickle files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "json" (
|
||||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can process the JSON files.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "htmlhelp" (
|
||||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run HTML Help Workshop with the ^
|
||||
.hhp project file in %BUILDDIR%/htmlhelp.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "qthelp" (
|
||||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PROJ.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PROJ.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "devhelp" (
|
||||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub" (
|
||||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "epub3" (
|
||||
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latex" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdf" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "latexpdfja" (
|
||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
||||
cd %BUILDDIR%/latex
|
||||
make all-pdf-ja
|
||||
cd %~dp0
|
||||
echo.
|
||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "text" (
|
||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The text files are in %BUILDDIR%/text.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "man" (
|
||||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "texinfo" (
|
||||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "gettext" (
|
||||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "changes" (
|
||||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.The overview file is in %BUILDDIR%/changes.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "linkcheck" (
|
||||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Link check complete; look for any errors in the above output ^
|
||||
or in %BUILDDIR%/linkcheck/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "doctest" (
|
||||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of doctests in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/doctest/output.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "coverage" (
|
||||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Testing of coverage in the sources finished, look at the ^
|
||||
results in %BUILDDIR%/coverage/python.txt.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "xml" (
|
||||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
||||
goto end
|
||||
)
|
||||
|
||||
if "%1" == "pseudoxml" (
|
||||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
||||
if errorlevel 1 exit /b 1
|
||||
echo.
|
||||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
||||
goto end
|
||||
)
|
||||
|
||||
:end
|
||||
|
|
@ -8,4 +8,3 @@
|
|||
|
||||
.. automodule:: django_celery_monitor.camera
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@
|
|||
|
||||
.. automodule:: django_celery_monitor.humanize
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@
|
|||
|
||||
.. automodule:: django_celery_monitor.managers
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@
|
|||
|
||||
.. automodule:: django_celery_monitor.models
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
|
|||
|
|
@ -8,4 +8,3 @@
|
|||
|
||||
.. automodule:: django_celery_monitor.utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
|
|||
32
docs/templates/readme.txt
vendored
32
docs/templates/readme.txt
vendored
|
|
@ -1,32 +0,0 @@
|
|||
================================================
|
||||
Celery Monitor for the Django admin framework.
|
||||
================================================
|
||||
|
||||
|build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
|
||||
|
||||
.. include:: ../includes/introduction.txt
|
||||
|
||||
.. include:: ../includes/installation.txt
|
||||
|
||||
.. |build-status| image:: https://secure.travis-ci.org/jezdez/django-celery-monitor.svg?branch=master
|
||||
:alt: Build status
|
||||
:target: https://travis-ci.org/jezdez/django-celery-monitor
|
||||
|
||||
.. |coverage| image:: https://codecov.io/github/jezdez/django-celery-monitor/coverage.svg?branch=master
|
||||
:target: https://codecov.io/github/jezdez/django-celery-monitor?branch=master
|
||||
|
||||
.. |license| image:: https://img.shields.io/pypi/l/django-celery-monitor.svg
|
||||
:alt: BSD License
|
||||
:target: https://opensource.org/licenses/BSD-3-Clause
|
||||
|
||||
.. |wheel| image:: https://img.shields.io/pypi/wheel/django-celery-monitor.svg
|
||||
:alt: django-celery-monitor can be installed via wheel
|
||||
:target: http://pypi.python.org/pypi/django-celery-monitor/
|
||||
|
||||
.. |pyversion| image:: https://img.shields.io/pypi/pyversions/django-celery-monitor.svg
|
||||
:alt: Supported Python versions.
|
||||
:target: http://pypi.python.org/pypi/django-celery-monitor/
|
||||
|
||||
.. |pyimp| image:: https://img.shields.io/pypi/implementation/django-celery-monitor.svg
|
||||
:alt: Support Python implementations.
|
||||
:target: http://pypi.python.org/pypi/django-celery-monitor/
|
||||
2
setup.py
2
setup.py
|
|
@ -146,7 +146,7 @@ setuptools.setup(
|
|||
platforms=['any'],
|
||||
license='BSD',
|
||||
classifiers=classifiers,
|
||||
install_requires=reqs('default.txt') + reqs('django.txt'),
|
||||
install_requires=reqs('default.txt'),
|
||||
tests_require=reqs('test.txt'),
|
||||
cmdclass={'test': pytest},
|
||||
zip_safe=False,
|
||||
|
|
|
|||
37
tox.ini
37
tox.ini
|
|
@ -2,16 +2,19 @@
|
|||
envlist =
|
||||
py{py,27,34,35}-dj{18,19,110}
|
||||
py36-dj111
|
||||
apicheck
|
||||
builddocs
|
||||
flake8
|
||||
flakeplus
|
||||
apicheck
|
||||
linkcheck
|
||||
pydocstyle
|
||||
|
||||
[travis]
|
||||
python =
|
||||
2.7: py27, flake8, flakeplus, apicheck, pydocstyle
|
||||
2.7: py27, apicheck, builddocs, flake8, flakeplus, linkcheck, pydocstyle
|
||||
|
||||
[testenv]
|
||||
sitepackages = False
|
||||
deps=
|
||||
-r{toxinidir}/requirements/default.txt
|
||||
-r{toxinidir}/requirements/test.txt
|
||||
|
|
@ -22,28 +25,14 @@ deps=
|
|||
dj110: -r{toxinidir}/requirements/test-django110.txt
|
||||
dj111: -r{toxinidir}/requirements/test-django111.txt
|
||||
|
||||
linkcheck,apicheck: -r{toxinidir}/requirements/docs.txt
|
||||
apicheck,builddocs,linkcheck: -r{toxinidir}/requirements/docs.txt
|
||||
flake8,flakeplus,pydocstyle: -r{toxinidir}/requirements/pkgutils.txt
|
||||
sitepackages = False
|
||||
commands =
|
||||
py.test -xv --cov=django_celery_monitor --cov-report=term --cov-report=xml --no-cov-on-fail
|
||||
|
||||
[testenv:apicheck]
|
||||
commands =
|
||||
sphinx-build -W -b apicheck -d {envtmpdir}/doctrees docs docs/_build/apicheck
|
||||
|
||||
[testenv:linkcheck]
|
||||
commands =
|
||||
sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/linkcheck
|
||||
|
||||
[testenv:flake8]
|
||||
commands =
|
||||
flake8 {toxinidir}/django_celery_monitor {toxinidir}/t
|
||||
|
||||
[testenv:flakeplus]
|
||||
commands =
|
||||
flakeplus --2.7 {toxinidir}/django_celery_monitor {toxinidir}/t
|
||||
|
||||
[testenv:pydocstyle]
|
||||
commands =
|
||||
pydocstyle {toxinidir}/django_celery_monitor
|
||||
py: py.test -xv --cov=django_celery_monitor --cov-report=term --cov-report=xml --no-cov-on-fail
|
||||
apicheck: sphinx-build -W -b apicheck -d {envtmpdir}/doctrees docs docs/_build/apicheck
|
||||
builddocs: sphinx-build -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html
|
||||
flake8: flake8 {toxinidir}/django_celery_monitor {toxinidir}/t
|
||||
flakeplus: flakeplus --2.7 {toxinidir}/django_celery_monitor {toxinidir}/t
|
||||
linkcheck: sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/linkcheck
|
||||
pydocstyle: pydocstyle {toxinidir}/django_celery_monitor
|
||||
|
|
|
|||
Loading…
Reference in a new issue