{ "info": { "author": "Henrik Holmboe", "author_email": "henrik@holmboe.se", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: System :: Distributed Computing" ], "description": "===============\r\nDjango Salt API\r\n===============\r\n\r\nThis Django app serves as a REST API for Salt. It is basically a very\r\nthing wrapper around the salt-api_ package.\r\n\r\n.. _salt-api: https://github.com/saltstack/salt-api\r\n\r\nStatus\r\n------\r\n\r\nThe main motivation behind creating a Django package to interface with\r\nSalt is that Django is already in our software stack. Since then\r\nsalt-api has become more flexible in the ways it can be deployed -- it\r\nis now possible to deploy its `rest_cherrypy`_ module on any compliant\r\nWSGI server (in contrast to running `salt-api` in a separate process).\r\nIn addition to that there is an even slimmer alternative, though with\r\nless features, in the `rest_wsgi`_ module. I encourage you to have a\r\nlook at them before deciding to use django-saltapi.\r\n\r\n.. _rest_cheerypy: http://salt-api.readthedocs.org/en/latest/ref/netapis/all/saltapi.netapi.rest_cherrypy.html\r\n.. _rest_wsgi: http://salt-api.readthedocs.org/en/latest/ref/netapis/all/saltapi.netapi.rest_wsgi.html\r\n\r\nSince salt-api has solved most of the motivations behind the inception\r\nof django-saltapi it is likely that this packages raison d'etre will\r\nbe to utilize more of the functionality in the Django REST Framework.\r\nFuture developments will likely be towards this goal.\r\n\r\nThis package comes with some caveats. This app compared to salt-api:\r\n\r\n - this app only supports x-www-form-urlencoded data input for the API\r\n wrapper or input snarfed from the URL, whereas salt-api supports\r\n other data formats\r\n\r\n - this app supports only JSON data output\r\n\r\n.. note:: Currently the API does not require authentication and two\r\n API functions are exposed without CSRF protection, though\r\n they are harmless from an integrity perspective. See\r\n `views.py` to enable authentication.\r\n\r\n\r\nInstallation\r\n------------\r\n\r\n1. Add `django_saltapi` to your `INSTALLED_APPS` setting in your\r\n project `settings.py`::\r\n\r\n INSTALLED_APPS = (\r\n [...]\r\n 'django_saltapi',\r\n )\r\n\r\n2. Add Salt settings in your project `settings.py`::\r\n\r\n SALT_CONFIG = {\r\n 'master_config': '/etc/salt/master',\r\n }\r\n\r\n2. Include the package URLconf in your project `urls.py` like so::\r\n\r\n url(r'^api/salt/', include('django_saltapi.urls')),\r\n\r\n\r\nUsage\r\n-----\r\n\r\n.. note:: The documentation and some scripts refer to the host as\r\n \"salt\" where the API is running, YMMV.\r\n\r\n1. Visit http://salt/api/salt/ to view the default static HTML page.\r\n\r\n2. Issue a Salt ping to all minions via the Salt API wrapper::\r\n\r\n django-saltapi '*' test.ping\r\n\r\n3. Try out the explicitly exposed REST API functions (see views.py)::\r\n\r\n django-saltapi-ping all\r\n django-saltapi-echo all x\r\n django-saltapi-job\r\n django-saltapi-job \r\n django-saltapi-minion\r\n django-saltapi-minion ", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/holmboe/django-saltapi", "keywords": "", "license": "Salt API - Generic bridging for access to Salt\r\n\r\n Copyright 2012 Salt Stack Inc.\r\n Copyright 2013 Henrik Holmboe\r\n\r\n Licensed under the Apache License, Version 2.0 (the \"License\");\r\n you may not use this file except in compliance with the License.\r\n You may obtain a copy of the License at\r\n\r\n http://www.apache.org/licenses/LICENSE-2.0\r\n\r\n Unless required by applicable law or agreed to in writing, software\r\n distributed under the License is distributed on an \"AS IS\" BASIS,\r\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n See the License for the specific language governing permissions and\r\n limitations under the License.", "maintainer": "", "maintainer_email": "", "name": "django-saltapi", "package_url": "https://pypi.org/project/django-saltapi/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-saltapi/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/holmboe/django-saltapi" }, "release_url": "https://pypi.org/project/django-saltapi/0.7.6/", "requires_dist": null, "requires_python": null, "summary": "This Django app serves as the REST API for Salt.", "version": "0.7.6" }, "last_serial": 1099572, "releases": { "0.7.5": [ { "comment_text": "", "digests": { "md5": "a9499f0b49349e36c37a50c35c8476e7", "sha256": "9d157236aff511eafca339eca0538ec79b839a221ce2a666cde7468fe4066243" }, "downloads": -1, "filename": "django-saltapi-0.7.5.tar.gz", "has_sig": false, "md5_digest": "a9499f0b49349e36c37a50c35c8476e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5076, "upload_time": "2013-03-06T15:38:07", "url": "https://files.pythonhosted.org/packages/26/66/a525fafc2531d6de83b0630c606947bf6bd72dcdb1af0eeec690b7fc741b/django-saltapi-0.7.5.tar.gz" } ], "0.7.6": [ { "comment_text": "", "digests": { "md5": "70bc45439b12f4166ec50abd02df98d4", "sha256": "80da15364b9e76e746ccf0cb87032a2ebc72dfb152ca3bf92f1825441f2e6a66" }, "downloads": -1, "filename": "django-saltapi-0.7.6.tar.gz", "has_sig": false, "md5_digest": "70bc45439b12f4166ec50abd02df98d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13266, "upload_time": "2013-03-12T13:37:30", "url": "https://files.pythonhosted.org/packages/5c/3b/d5b4085b4cb6696d3e3f52fe0b8f5321520942797ffc5e4c5e03bb873cae/django-saltapi-0.7.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "70bc45439b12f4166ec50abd02df98d4", "sha256": "80da15364b9e76e746ccf0cb87032a2ebc72dfb152ca3bf92f1825441f2e6a66" }, "downloads": -1, "filename": "django-saltapi-0.7.6.tar.gz", "has_sig": false, "md5_digest": "70bc45439b12f4166ec50abd02df98d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13266, "upload_time": "2013-03-12T13:37:30", "url": "https://files.pythonhosted.org/packages/5c/3b/d5b4085b4cb6696d3e3f52fe0b8f5321520942797ffc5e4c5e03bb873cae/django-saltapi-0.7.6.tar.gz" } ] }