# django-simpletask2-server
The server program used with django-simpletask2. After startup, it can automatically process the asynchronous processing tasks generated by django-simpletask2.
## Install
```
pip install django-simpletask2-server
```
## Usage
```
test@test django-simpletask2-server % django-simpletask2-server --help
Usage: django-simpletask2-server [OPTIONS] COMMAND [ARGS]...
Options:
--logfmt TEXT
--logfile TEXT
--loglevel TEXT
--pidfile TEXT pidfile file path.
--workspace TEXT Set running folder
--daemon / --no-daemon Run application in background or in
foreground.
-c, --config TEXT Config file path. Application will search
config file if this option is missing. Use
sub-command show-config-fileapaths to get
the searching tactics.
--error-sleep INTEGER
--idle-sleep INTEGER
-t, --threads INTEGER
--auto-reset-task-interval INTEGER
--do-auto-reset-task / --no-do-auto-reset-task
--task-pull-timeout INTEGER
--task-pull-engine TEXT
--channel-flags-template TEXT
--channel-name-strip-regex TEXT
--channel-name-template TEXT
--channels TEXT
-r, --redis TEXT
-a, --aclkey TEXT
-s, --server TEXT
--help Show this message and exit.
Commands:
restart Restart Daemon application.
show-config-filepaths Print out the config searching paths.
show-configs Print out the final config items.
start Start daemon application.
stop Stop daemon application.
```
## Config items
- server: Required. Default to: http://127.0.0.1:8000/django-simpletask2/。
- aclkey: Required. No default value.
- redis: It is required when task-pull-engine is "redis". The value format likes: redis://:password@redis-server:redis-port/redis-db?decode_responses=True (The option decode_responses=True is required)
- channels: Required. Default to "default".
- threads: Required. Default to 1.
- task-pull-engine Required. Default to "redis". Other options are: api.
- idle_sleep: Default to 5 seconds.
- error_sleep: Default to 5 seconds.
- Other config items like logdevel, logfile, logfmt, workspace, pidfile, daemon and so on, see details of `daemon-application`.
## Releases
### v0.0.8
- Doc update.
### v0.0.7
- Fix --channels option short name conflict problem.
### v0.0.6
- First release.
Raw data
{
"_id": null,
"home_page": null,
"name": "django-simpletask2-server",
"maintainer": "Yang BangJiang",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django-simpletask2",
"author": "Yang BangJiang",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/aa/f1/26fb9896b8cc8d78d643be17a18874b1c9f7d441a2ab27d231fb282e40fb/django-simpletask2-server-0.1.1.tar.gz",
"platform": null,
"description": "# django-simpletask2-server\n\nThe server program used with django-simpletask2. After startup, it can automatically process the asynchronous processing tasks generated by django-simpletask2.\n\n## Install\n\n```\npip install django-simpletask2-server\n```\n\n## Usage\n\n```\ntest@test django-simpletask2-server % django-simpletask2-server --help\nUsage: django-simpletask2-server [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --logfmt TEXT\n --logfile TEXT\n --loglevel TEXT\n --pidfile TEXT pidfile file path.\n --workspace TEXT Set running folder\n --daemon / --no-daemon Run application in background or in\n foreground.\n -c, --config TEXT Config file path. Application will search\n config file if this option is missing. Use\n sub-command show-config-fileapaths to get\n the searching tactics.\n --error-sleep INTEGER\n --idle-sleep INTEGER\n -t, --threads INTEGER\n --auto-reset-task-interval INTEGER\n --do-auto-reset-task / --no-do-auto-reset-task\n --task-pull-timeout INTEGER\n --task-pull-engine TEXT\n --channel-flags-template TEXT\n --channel-name-strip-regex TEXT\n --channel-name-template TEXT\n --channels TEXT\n -r, --redis TEXT\n -a, --aclkey TEXT\n -s, --server TEXT\n --help Show this message and exit.\n\nCommands:\n restart Restart Daemon application.\n show-config-filepaths Print out the config searching paths.\n show-configs Print out the final config items.\n start Start daemon application.\n stop Stop daemon application.\n\n```\n\n## Config items\n\n- server: Required. Default to: http://127.0.0.1:8000/django-simpletask2/\u3002\n- aclkey: Required. No default value.\n- redis: It is required when task-pull-engine is \"redis\". The value format likes: redis://:password@redis-server:redis-port/redis-db?decode_responses=True (The option decode_responses=True is required)\n- channels: Required. Default to \"default\".\n- threads: Required. Default to 1.\n- task-pull-engine Required. Default to \"redis\". Other options are: api.\n- idle_sleep: Default to 5 seconds.\n- error_sleep: Default to 5 seconds.\n- Other config items like logdevel, logfile, logfmt, workspace, pidfile, daemon and so on, see details of `daemon-application`.\n\n## Releases\n\n### v0.0.8\n\n- Doc update.\n\n### v0.0.7\n\n- Fix --channels option short name conflict problem.\n\n### v0.0.6\n\n- First release.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django simpletask2 handler server.",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"django-simpletask2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b776e930137944d7551f8ca60b0d2d8e17715b1456dcef914222a7e8282cc5f",
"md5": "a7fcf4cb01d79c4e54134e66cf401f8c",
"sha256": "ce33fbcce0ee53ff8de4bcace686844fa4b90b7e7a3033b69b87b958e5909428"
},
"downloads": -1,
"filename": "django_simpletask2_server-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7fcf4cb01d79c4e54134e66cf401f8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6190,
"upload_time": "2024-06-18T15:28:59",
"upload_time_iso_8601": "2024-06-18T15:28:59.267591Z",
"url": "https://files.pythonhosted.org/packages/8b/77/6e930137944d7551f8ca60b0d2d8e17715b1456dcef914222a7e8282cc5f/django_simpletask2_server-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aaf126fb9896b8cc8d78d643be17a18874b1c9f7d441a2ab27d231fb282e40fb",
"md5": "99516595e58793937f1db765765d012f",
"sha256": "8429316db1370870c94aa188d759aa6b9ccb9f62f4502203b1615a21310a4634"
},
"downloads": -1,
"filename": "django-simpletask2-server-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "99516595e58793937f1db765765d012f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6711,
"upload_time": "2024-06-18T15:29:04",
"upload_time_iso_8601": "2024-06-18T15:29:04.382112Z",
"url": "https://files.pythonhosted.org/packages/aa/f1/26fb9896b8cc8d78d643be17a18874b1c9f7d441a2ab27d231fb282e40fb/django-simpletask2-server-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 15:29:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "django-simpletask2-server"
}
JSON