| Name | django-tours JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | Django app to display tours with shepherdjs |
| upload_time | 2024-06-18 16:29:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Wilmer Martinez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
tours
shepherdjs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# django-tours
Django app to display tours with [shepherdjs](https://shepherdjs.dev/)
## Instalation
```sh
pip install django-tours
```
## Use
### Add to installed applications
```py
# settings.py
INSTALLED_APPS = [
# ...
'tours',
# ...
]
```
### Optional configuration:
**If you want to set default variables, you can add the following in your settings.py file:**
```py
# settings.py
DEFAULT_SHEPHERD_JS = 'https://cdn.jsdelivr.net/npm/shepherd.js@latest/dist/js/shepherd.min.js'
DEFAULT_SHEPHERD_CSS = 'https://cdn.jsdelivr.net/npm/shepherd.js@latest/dist/css/shepherd.css'
```
### Add the URLs
```py
urlpatterns = [
# ...
path('tours/', include('tours.urls')),
# ...
]
```
### Run the migrations
```sh
python manage.py migrate
```
### Load tours into the template
```django
{% load tours %}
{% load_tours request %}
```
## Licence
This project is licensed under the MIT License. See [LICENSE](LICENSE) file for details.
## Proyect Status
This project is in Production/Stable ✔
## Contribution 💗
If you find value in this project and would like to show your support, please consider making a donation via PayPal:
[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)
Your generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!
Raw data
{
"_id": null,
"home_page": null,
"name": "django-tours",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "django, tours, shepherdjs",
"author": null,
"author_email": "Wilmer Martinez <info@wilmermartinez.dev>",
"download_url": "https://files.pythonhosted.org/packages/5f/a0/368caf1a8e8d77186e479ef2d6427f670b700b5df3847ea4faf263d7dd32/django_tours-1.1.1.tar.gz",
"platform": null,
"description": "# django-tours\n\nDjango app to display tours with [shepherdjs](https://shepherdjs.dev/)\n\n![Python Logo](https://www.python.org/static/community_logos/python-logo.png \"Sample inline image\")\n\n\n\n## Instalation\n\n```sh\npip install django-tours\n```\n\n## Use\n\n### Add to installed applications\n\n```py\n# settings.py\n\nINSTALLED_APPS = [\n # ...\n 'tours',\n # ...\n]\n```\n\n### Optional configuration:\n\n**If you want to set default variables, you can add the following in your settings.py file:**\n\n```py\n# settings.py\n\nDEFAULT_SHEPHERD_JS = 'https://cdn.jsdelivr.net/npm/shepherd.js@latest/dist/js/shepherd.min.js'\nDEFAULT_SHEPHERD_CSS = 'https://cdn.jsdelivr.net/npm/shepherd.js@latest/dist/css/shepherd.css'\n```\n\n### Add the URLs\n\n```py\nurlpatterns = [\n # ...\n path('tours/', include('tours.urls')),\n # ...\n]\n```\n\n### Run the migrations\n\n```sh\npython manage.py migrate\n```\n\n### Load tours into the template\n\n```django\n{% load tours %}\n\n{% load_tours request %}\n```\n\n## Licence\n\nThis project is licensed under the MIT License. See [LICENSE](LICENSE) file for details.\n\n## Proyect Status\n\nThis project is in Production/Stable \u2714\n\n## Contribution \ud83d\udc97\n\nIf you find value in this project and would like to show your support, please consider making a donation via PayPal:\n\n[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)\n\nYour generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Wilmer Martinez Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Django app to display tours with shepherdjs",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://wilmermartinez.dev/codigos/django-tours/",
"Issues": "https://github.com/wilmerm/django-tours/issues",
"Repository": "https://github.com/wilmerm/django-tours"
},
"split_keywords": [
"django",
" tours",
" shepherdjs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ffd2f372fee92e74a51b76f2b2755c5a733ad90260b90225bd30ac013d41215",
"md5": "00bd7feeed64ba44edf79bc827a81b7b",
"sha256": "0e6a57c4e2b6854b052aaf03b9b173cee9e1219625bd4613ed870e35e482560f"
},
"downloads": -1,
"filename": "django_tours-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00bd7feeed64ba44edf79bc827a81b7b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11256,
"upload_time": "2024-06-18T16:29:04",
"upload_time_iso_8601": "2024-06-18T16:29:04.319635Z",
"url": "https://files.pythonhosted.org/packages/4f/fd/2f372fee92e74a51b76f2b2755c5a733ad90260b90225bd30ac013d41215/django_tours-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fa0368caf1a8e8d77186e479ef2d6427f670b700b5df3847ea4faf263d7dd32",
"md5": "17b4cf2043739b33187ce628df6362b7",
"sha256": "2a856e895d36066ed1283eab83cc5399871391e626fce26a65ec19ee902f7618"
},
"downloads": -1,
"filename": "django_tours-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "17b4cf2043739b33187ce628df6362b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8203,
"upload_time": "2024-06-18T16:29:08",
"upload_time_iso_8601": "2024-06-18T16:29:08.229102Z",
"url": "https://files.pythonhosted.org/packages/5f/a0/368caf1a8e8d77186e479ef2d6427f670b700b5df3847ea4faf263d7dd32/django_tours-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 16:29:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wilmerm",
"github_project": "django-tours",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "django-tours"
}
