# Django Analytics Simple
**See documentation at :** [Español](README_es.md) | [English](README.md)
Django Analytics simple is a Django package designed to facilitate tracking and analysis of user data in web applications. It provides middleware that records information about users, including details such as browser, operating system, device, and geographical location. The collected data is stored in a new database table, enabling detailed analytics to improve user experience and make informed decisions in application development and maintenance.
## Installation
You can install Django Analytics simple using pip:
```bash
pip install django_analytics_simple
```
Then, add 'django_analytics' to your Django project's installed apps in the settings.py file:
```python
INSTALLED_APPS = [
...
'django_analytics_simple',
...
]
```
Next, include the provided middleware in your project's middleware stack in the same settings.py file:
```python
MIDDLEWARE = [
...
'django_analytics_simple.middleware.AnalyticsMiddleware',
...
]
```
## Configuration
Django Analytics simple requires the GeoLite2-City.mmdb file for IP geolocation, which should already be included in the package, and it will be updated monthly.
Additionally, you can set the ANALYTICS_LANGUAGE variable in your Django project's settings.py file to specify the language for location data retrieval.
```python
ANALYTICS_LANGUAGE = 'en' # Specify the language for location data retrieval
```
Please note that you may need to review the languages supported by MaxMindDB for proper configuration.
## Dependencies
Django Analytics simple relies on the following external libraries:
[MaxMindDB] https://pypi.org/project/maxminddb/
[User-agents] https://pypi.org/project/user-agents/
Ensure that these dependencies are installed before using Django Analytics.
## Usage
After configuring Django Analytics simple, run the following commands to apply migrations:
```bash
python manage.py makemigrations django_analytics_simple
python manage.py migrate
```
## License
This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. See the LICENSE file for details.
## Author
[Santiago Nestor Britos](mailto:s.britos@hotmail.com) - s.britos@hotmail.com
Raw data
{
"_id": null,
"home_page": null,
"name": "django-analytics-simple",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "Analytics, Application Development, Browser, Data, Database, Device, Django, Geographical Location, Informed Decisions, Maintenance, Middleware, Operating System, Table, Tracking, User, User Experience",
"author": null,
"author_email": "Santiago Nestor Britos <s.britos@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1b/f1/38294d42fdfea1f45efc24fc4b1c00f58ee454cb2c65cfbc582d99535cb9/django_analytics_simple-2024.0.9.tar.gz",
"platform": null,
"description": "# Django Analytics Simple\n\n**See documentation at :** [Espa\u00f1ol](README_es.md) | [English](README.md)\n\nDjango Analytics simple is a Django package designed to facilitate tracking and analysis of user data in web applications. It provides middleware that records information about users, including details such as browser, operating system, device, and geographical location. The collected data is stored in a new database table, enabling detailed analytics to improve user experience and make informed decisions in application development and maintenance.\n\n## Installation\n\nYou can install Django Analytics simple using pip:\n\n```bash\npip install django_analytics_simple\n```\n\nThen, add 'django_analytics' to your Django project's installed apps in the settings.py file:\n\n```python\nINSTALLED_APPS = [\n ...\n 'django_analytics_simple',\n ...\n]\n```\n\nNext, include the provided middleware in your project's middleware stack in the same settings.py file:\n\n```python\nMIDDLEWARE = [\n ...\n 'django_analytics_simple.middleware.AnalyticsMiddleware',\n ...\n]\n```\n\n## Configuration\nDjango Analytics simple requires the GeoLite2-City.mmdb file for IP geolocation, which should already be included in the package, and it will be updated monthly.\n\nAdditionally, you can set the ANALYTICS_LANGUAGE variable in your Django project's settings.py file to specify the language for location data retrieval.\n\n\n```python\nANALYTICS_LANGUAGE = 'en' # Specify the language for location data retrieval\n```\n\nPlease note that you may need to review the languages supported by MaxMindDB for proper configuration.\n\n\n## Dependencies\n\nDjango Analytics simple relies on the following external libraries:\n\n[MaxMindDB] https://pypi.org/project/maxminddb/\n[User-agents] https://pypi.org/project/user-agents/\nEnsure that these dependencies are installed before using Django Analytics.\n\n## Usage\n\nAfter configuring Django Analytics simple, run the following commands to apply migrations:\n\n```bash\npython manage.py makemigrations django_analytics_simple\npython manage.py migrate\n```\n\n## License\n\nThis project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. See the LICENSE file for details.\n\n## Author\n\n[Santiago Nestor Britos](mailto:s.britos@hotmail.com) - s.britos@hotmail.com",
"bugtrack_url": null,
"license": "Creative Commons License Attribution-NonCommercial-NoDerivatives 4.0 International You are free to: - Share: copy and redistribute the material in any medium or format. Under the following terms: - Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. - NonCommercial: You may not use the material for commercial purposes. - NoDerivatives: If you remix, transform, or build upon the material, you may not distribute the modified material. Notices: You are not required to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.",
"summary": "Django Analytics simple is a package designed to facilitate tracking and analysis of data in Django web applications",
"version": "2024.0.9",
"project_urls": {
"Repository": "https://github.com/h4cker54n/django_analytics_simple"
},
"split_keywords": [
"analytics",
" application development",
" browser",
" data",
" database",
" device",
" django",
" geographical location",
" informed decisions",
" maintenance",
" middleware",
" operating system",
" table",
" tracking",
" user",
" user experience"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5398e82c87f8ac7f293074031102c9ca6dd8b11595b7303f5ee75a76a6035b8",
"md5": "280822e610e8300f8c34546ad580f4b9",
"sha256": "5ee6647384e47778f162ddc41afbcd7dc80b55f501fa0d7fca2440674c9ab109"
},
"downloads": -1,
"filename": "django_analytics_simple-2024.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "280822e610e8300f8c34546ad580f4b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 26166920,
"upload_time": "2024-04-12T07:41:11",
"upload_time_iso_8601": "2024-04-12T07:41:11.985107Z",
"url": "https://files.pythonhosted.org/packages/f5/39/8e82c87f8ac7f293074031102c9ca6dd8b11595b7303f5ee75a76a6035b8/django_analytics_simple-2024.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1bf138294d42fdfea1f45efc24fc4b1c00f58ee454cb2c65cfbc582d99535cb9",
"md5": "9003254d89ea116d2611834d8d7533fb",
"sha256": "5d9d4cb1bc58d291164fb0e1e57587c4e507d09c5887240a8ff9843ce94c75fd"
},
"downloads": -1,
"filename": "django_analytics_simple-2024.0.9.tar.gz",
"has_sig": false,
"md5_digest": "9003254d89ea116d2611834d8d7533fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 25921596,
"upload_time": "2024-04-12T07:42:19",
"upload_time_iso_8601": "2024-04-12T07:42:19.329771Z",
"url": "https://files.pythonhosted.org/packages/1b/f1/38294d42fdfea1f45efc24fc4b1c00f58ee454cb2c65cfbc582d99535cb9/django_analytics_simple-2024.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 07:42:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "h4cker54n",
"github_project": "django_analytics_simple",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "django-analytics-simple"
}
