django-helpdesk - A Django powered ticket tracker for small businesses.
=======================================================================
.. image:: https://dev.azure.com/django-helpdesk/django-helpdesk/_apis/build/status/django-helpdesk.django-helpdesk?branchName=master
:target: https://dev.azure.com/django-helpdesk/django-helpdesk/_build/latest?definitionId=1&branchName=master
:alt: Build Status
.. image:: https://codecov.io/gh/django-helpdesk/django-helpdesk/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/django-helpdesk/django-helpdesk
Copyright 2009-2025 Ross Poulton and django-helpdesk contributors. All Rights Reserved.
See LICENSE for details.
django-helpdesk was formerly known as Jutda Helpdesk, named after the
company which originally created it. As of January 2011 the name has been
changed to reflect what it really is: a Django-powered ticket tracker with
contributors reaching far beyond Jutda.
Complete documentation is available in the docs/ directory,
or online at http://django-helpdesk.readthedocs.org/.
Demo Quickstart
---------------
`django-helpdesk` includes a basic demo Django project so that you may easily
get started with testing or developing `django-helpdesk`. The demo project
resides in the `demodesk/` top-level folder.
You will need to install the `uv` package manager to simplify setting up the demo:
https://docs.astral.sh/uv/getting-started/installation/
If you have not already created a virtual environment then run this command:
uv venv
To start up a demo project server, run this command:
make rundemo
or with docker::
docker build . -t demodesk
docker run --rm -v "$PWD:/app" -p 8080:8080 demodesk
then pointing your web browser at http://localhost:8080 (log in as user
`admin` with password `Pa33w0rd`, defined in the `demo.json` fixture file).
For more information and options, please read the `demo/README.rst` file.
**NOTE REGARDING SQLITE AND SEARCHING:**
The demo project uses `sqlite` as its database. Sqlite does not allow
case-insensitive searches and so the search function may not work as
effectively as it would on other database such as PostgreSQL or MySQL
that does support case-insensitive searches.
For more information, see this note_ in the Django documentation.
When you try to do a keyword search using `sqlite`, a message will be displayed
to alert you to this shortcoming. There is no way around it, sorry.
Installation
------------
* |standalone_icon| For **standalone** installation, refer to `standalone documentation <./docs/standalone.rst>`_.
* |django_icon| To **integrate** with an existing Django application, follow the guidelines in `installation documentation <./docs/install.rst>`_ and `configuration documentation <./docs/configuration.rst>`_.
.. |standalone_icon| image:: helpdesk/static/helpdesk/img/icon512.png
:height: 24px
:width: 24px
:align: middle
.. |django_icon| image:: helpdesk/static/helpdesk/img/django-logo-positive.png
:height: 24px
:width: 60px
:align: middle
Developer Environment
---------------------
The project uses the modern `uv` package manager: https://docs.astral.sh/uv/
There are a number of options that make life a lot easier in the Makefile.
To see option for the Makefile run: `make`
Follow these steps to set up your development environment to contribute to helpdesk:
- check out the helpdesk app to your local file system::
git clone https://github.com/django-helpdesk/django-helpdesk.git
- Install the `uv` package manager::
https://docs.astral.sh/uv/getting-started/installation/
- install a virtual environment ::
uv venv
- install the requirements for development::
make develop
- you can install optional dependencies using the --group option. The `make develop` script installs test dependencies.
# This installs pinax teams dependencies for production
uv sync --all-extras --group teams
# This installs pinax teams dependencies as well as test
uv sync --all-extras --dev --group test --group teams
If you prefer working within an activated virtual environment instead of using the `uv` tool
then you can use the normal command after the above step for creating the virtualenv to activate it::
source .venv/bin/activate
- or depending on your shell it might be:
. .venv/bin/activate
The project enforces a standardized formatting in the CI/CD pipeline. To ensure you have the correct formatting run::
make checkformat
To auto format any code use this::
make format
Testing
-------
From the command line you can run all the tests using: `make test`
To run specific tests then run quicktest.py with arguments in an activated virtualenv or use this:
uv run quicktest.py <arg>
See `quicktest.py` for usage details.
If you need to create tests for new features, add your tests in a test file to the `tests` module::
- from an activated virtualenv use::
python quicktest.py helpdesk.tests.test_my_new_features -v 2
- whether a virtualenv is activated or not you can use this command::
uv run quicktest.py helpdesk.tests.test_my_new_features -v 2
Upgrading from previous versions
--------------------------------
If you are upgrading from a previous version of `django-helpdesk` that used
migrations, get an up to date version of the code base (eg by using
`git pull` or `pip install --upgrade django-helpdesk`) then migrate the database::
python manage.py migrate helpdesk --db-dry-run # DB untouched
python manage.py migrate helpdesk
Lastly, restart your web server software (eg Apache) or FastCGI instance, to
ensure the latest changes are in use.
You can continue to the 'Initial Configuration' area, if needed.
Contributing
------------
We're happy to include any type of contribution! This can be:
* back-end python/django code development
* front-end web development (HTML/Javascript, especially jQuery)
* language translations
* writing improved documentation and demos
For more information on contributing, please see the `CONTRIBUTING.rst` file.
Licensing
---------
django-helpdesk is licensed under terms of the BSD 3-clause license.
See the `LICENSE` file for full licensing terms.
Note that django-helpdesk is distributed with 3rd party products which
have their own licenses. See LICENSE.3RDPARTY for license terms for
included packages.
.. _note: https://docs.djangoproject.com/en/dev/ref/databases/#substring-matching-and-case-sensitivity
Raw data
{
"_id": null,
"home_page": null,
"name": "django-helpdesk",
"maintainer": "David Vadnais - Github@DavidVadnais, Ben - Github:@Benbb96",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Christopher Broderick <uhurusurfa@gmail.com>",
"keywords": "django, helpdesk, django-helpdesk, tickets, incidents, cases, bugs, track, support",
"author": null,
"author_email": "Ross Poulton <ross@rossp.org>",
"download_url": "https://files.pythonhosted.org/packages/b2/03/1be1842654b30179a16d4e763f2fb34280ff0aeaf74b3fcebdec6f87dbf1/django_helpdesk-2.0.1.tar.gz",
"platform": null,
"description": "django-helpdesk - A Django powered ticket tracker for small businesses.\n=======================================================================\n\n.. image:: https://dev.azure.com/django-helpdesk/django-helpdesk/_apis/build/status/django-helpdesk.django-helpdesk?branchName=master\n :target: https://dev.azure.com/django-helpdesk/django-helpdesk/_build/latest?definitionId=1&branchName=master\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/django-helpdesk/django-helpdesk/branch/develop/graph/badge.svg\n :target: https://codecov.io/gh/django-helpdesk/django-helpdesk\n\nCopyright 2009-2025 Ross Poulton and django-helpdesk contributors. All Rights Reserved.\nSee LICENSE for details.\n\ndjango-helpdesk was formerly known as Jutda Helpdesk, named after the\ncompany which originally created it. As of January 2011 the name has been\nchanged to reflect what it really is: a Django-powered ticket tracker with\ncontributors reaching far beyond Jutda.\n\nComplete documentation is available in the docs/ directory,\nor online at http://django-helpdesk.readthedocs.org/.\n\n\nDemo Quickstart\n---------------\n\n`django-helpdesk` includes a basic demo Django project so that you may easily\nget started with testing or developing `django-helpdesk`. The demo project\nresides in the `demodesk/` top-level folder.\n\nYou will need to install the `uv` package manager to simplify setting up the demo:\n https://docs.astral.sh/uv/getting-started/installation/\n\nIf you have not already created a virtual environment then run this command:\n uv venv\n\nTo start up a demo project server, run this command:\n\n make rundemo\n\nor with docker::\n\n docker build . -t demodesk\n docker run --rm -v \"$PWD:/app\" -p 8080:8080 demodesk\n\nthen pointing your web browser at http://localhost:8080 (log in as user\n`admin` with password `Pa33w0rd`, defined in the `demo.json` fixture file).\n\nFor more information and options, please read the `demo/README.rst` file.\n\n**NOTE REGARDING SQLITE AND SEARCHING:**\nThe demo project uses `sqlite` as its database. Sqlite does not allow\ncase-insensitive searches and so the search function may not work as\neffectively as it would on other database such as PostgreSQL or MySQL\nthat does support case-insensitive searches.\nFor more information, see this note_ in the Django documentation.\n\nWhen you try to do a keyword search using `sqlite`, a message will be displayed\nto alert you to this shortcoming. There is no way around it, sorry.\n\nInstallation\n------------\n\n* |standalone_icon| For **standalone** installation, refer to `standalone documentation <./docs/standalone.rst>`_.\n\n* |django_icon| To **integrate** with an existing Django application, follow the guidelines in `installation documentation <./docs/install.rst>`_ and `configuration documentation <./docs/configuration.rst>`_.\n\n.. |standalone_icon| image:: helpdesk/static/helpdesk/img/icon512.png\n :height: 24px\n :width: 24px\n :align: middle\n\n.. |django_icon| image:: helpdesk/static/helpdesk/img/django-logo-positive.png\n :height: 24px\n :width: 60px\n :align: middle\n\nDeveloper Environment\n---------------------\nThe project uses the modern `uv` package manager: https://docs.astral.sh/uv/\nThere are a number of options that make life a lot easier in the Makefile.\nTo see option for the Makefile run: `make`\n\nFollow these steps to set up your development environment to contribute to helpdesk:\n - check out the helpdesk app to your local file system::\n\n git clone https://github.com/django-helpdesk/django-helpdesk.git\n \n - Install the `uv` package manager::\n https://docs.astral.sh/uv/getting-started/installation/\n\n - install a virtual environment ::\n \n uv venv\n\n - install the requirements for development::\n\n make develop\n\n - you can install optional dependencies using the --group option. The `make develop` script installs test dependencies.\n \n # This installs pinax teams dependencies for production\n uv sync --all-extras --group teams\n # This installs pinax teams dependencies as well as test\n uv sync --all-extras --dev --group test --group teams\n \n\nIf you prefer working within an activated virtual environment instead of using the `uv` tool\nthen you can use the normal command after the above step for creating the virtualenv to activate it::\n \n source .venv/bin/activate\n\n - or depending on your shell it might be:\n . .venv/bin/activate\n\nThe project enforces a standardized formatting in the CI/CD pipeline. To ensure you have the correct formatting run::\n\n make checkformat\n \nTo auto format any code use this::\n\n make format\n\nTesting\n-------\n\nFrom the command line you can run all the tests using: `make test`\n\nTo run specific tests then run quicktest.py with arguments in an activated virtualenv or use this:\n uv run quicktest.py <arg>\n\nSee `quicktest.py` for usage details.\n\nIf you need to create tests for new features, add your tests in a test file to the `tests` module::\n\n - from an activated virtualenv use::\n python quicktest.py helpdesk.tests.test_my_new_features -v 2\n\n - whether a virtualenv is activated or not you can use this command::\n uv run quicktest.py helpdesk.tests.test_my_new_features -v 2\n\nUpgrading from previous versions\n--------------------------------\n\nIf you are upgrading from a previous version of `django-helpdesk` that used\nmigrations, get an up to date version of the code base (eg by using\n`git pull` or `pip install --upgrade django-helpdesk`) then migrate the database::\n\n python manage.py migrate helpdesk --db-dry-run # DB untouched\n python manage.py migrate helpdesk\n\nLastly, restart your web server software (eg Apache) or FastCGI instance, to\nensure the latest changes are in use.\n\nYou can continue to the 'Initial Configuration' area, if needed.\n\nContributing\n------------\n\nWe're happy to include any type of contribution! This can be:\n\n* back-end python/django code development\n* front-end web development (HTML/Javascript, especially jQuery)\n* language translations\n* writing improved documentation and demos\n\nFor more information on contributing, please see the `CONTRIBUTING.rst` file.\n\n\nLicensing\n---------\n\ndjango-helpdesk is licensed under terms of the BSD 3-clause license.\nSee the `LICENSE` file for full licensing terms.\n\nNote that django-helpdesk is distributed with 3rd party products which\nhave their own licenses. See LICENSE.3RDPARTY for license terms for\nincluded packages.\n\n.. _note: https://docs.djangoproject.com/en/dev/ref/databases/#substring-matching-and-case-sensitivity\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Django-powered ticket tracker for your helpdesk",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/django-helpdesk/django-helpdesk"
},
"split_keywords": [
"django",
" helpdesk",
" django-helpdesk",
" tickets",
" incidents",
" cases",
" bugs",
" track",
" support"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "26572b61ed007335843b91db22c381ef7de04c1c90f4b312adcb67154b3decec",
"md5": "1a8cc22d18b4ace2b57056c904870c99",
"sha256": "d202f3203ca8f0d811703c9184ab06adf64b9c1b2e7082d1454b4f0b90dcf922"
},
"downloads": -1,
"filename": "django_helpdesk-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a8cc22d18b4ace2b57056c904870c99",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10390743,
"upload_time": "2025-09-02T19:22:26",
"upload_time_iso_8601": "2025-09-02T19:22:26.185122Z",
"url": "https://files.pythonhosted.org/packages/26/57/2b61ed007335843b91db22c381ef7de04c1c90f4b312adcb67154b3decec/django_helpdesk-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b2031be1842654b30179a16d4e763f2fb34280ff0aeaf74b3fcebdec6f87dbf1",
"md5": "8496f2a7ce18188e9d11f6b28064441e",
"sha256": "0e87016a208bd40db963920d03309cd0c3784e9d003d6fc75bf8ba5646987875"
},
"downloads": -1,
"filename": "django_helpdesk-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8496f2a7ce18188e9d11f6b28064441e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9334612,
"upload_time": "2025-09-02T19:22:29",
"upload_time_iso_8601": "2025-09-02T19:22:29.844047Z",
"url": "https://files.pythonhosted.org/packages/b2/03/1be1842654b30179a16d4e763f2fb34280ff0aeaf74b3fcebdec6f87dbf1/django_helpdesk-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 19:22:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-helpdesk",
"github_project": "django-helpdesk",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "django-helpdesk"
}
JSON
