automatic import of python-django-amplitudeopeneuler20.03

3 files changed, 599 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..33be0d1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/django-amplitude-0.7.1.tar.gz
diff --git a/python-django-amplitude.spec b/python-django-amplitude.spec
new file mode 100644
index 0000000..7ab5ca7
--- /dev/null
+++ b/python-django-amplitude.spec
@@ -0,0 +1,597 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-django-amplitude
+Version:	0.7.1
+Release:	1
+Summary:	Integration between Django and Amplitude
+License:	MIT
+URL:		https://github.com/pyepye/django-amplitude
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/ce/bd/9755aaff2a45eaf5f283f6ef3cbef3342c14c03f8840dad2b01b445ccf35/django-amplitude-0.7.1.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-Django
+Requires:	python3-httpx
+Requires:	python3-user-agents
+
+%description
+# Django Amplitude
+
+Integration between Django and [Amplitude.com](https://amplitude.com/) to help send events via the [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2)
+
+
+## Quick start
+
+### Installation
+
+```bash
+pip install django-amplitude
+```
+
+Add `amplitude` to your `INSTALLED_APPS`. If they are not already the Django `sessions` app must also be added:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'django.contrib.sessions',
+    ...
+    'amplitude',
+]
+```
+
+If you do not have it already you must also add the Django `django.contrib.sessions.middleware.SessionMiddleware`. Then add the ampliturde `SessionInfo` middleware after the `SessionMiddleware`:
+```python
+MIDDLEWARE = [
+    ...
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    ...
+    'amplitude.middleware.SessionInfo',
+]
+```
+
+Now set your Amplitude API key and user / group options in your `settings.py`:
+```python
+# Settings > Projects > <Your project> > General > API Key
+AMPLITUDE_API_KEY = '<amplitude-project-api-key>'
+
+# You can also choose if you want to include user and group data (Default False)
+AMPLITUDE_INCLUDE_USER_DATA = False
+AMPLITUDE_INCLUDE_GROUP_DATA = False
+```
+
+*Note: If you want to include user or group data you must ensure the [Django auth is setup correctly](https://docs.djangoproject.com/en/3.0/topics/auth/#installation). This includes adding `django.contrib.auth` and `django.contrib.contenttypes` to `INSTALLED_APPS` and `django.contrib.auth.middleware.AuthenticationMiddleware` to `MIDDLEWARE`*.
+
+
+For more information on the above settings see the [configuration settings](#configuration-settings) section.
+
+
+
+## Usage
+
+### Page view events
+
+If you want to send an event to Amplitude on every page view you can use the django-amplitude `SendPageViewEvent` middleware to your `MIDDLEWARE` in your Django settings.
+
+This will automatically create an event called `Page view` with all the information it's possible to pull from the Django request object such as URL path and parameters, user agent info, IP info, user info etc.
+
+It must be placed after the `amplitude.middleware.SessionInfo` middleware:
+
+```python
+MIDDLEWARE = [
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    ...
+    'amplitude.middleware.SessionInfo',
+    'amplitude.middleware.SendPageViewEvent',
+]
+```
+
+While using `SendPageViewEvent` if there are certain URLs that you do not want to update Amplitude with you can use the `AMPLITUDE_IGNORE_URLS` setting. This setting take a list of relative urls or URL names. Relative URLS most match exactly so need to start with a forward slash (`/`)
+
+```python
+AMPLITUDE_IGNORE_URLS = ['my_url_name', '/testurl']
+```
+
+
+### Sending events manually
+
+If you want to send your own events:
+```python
+from amplitude import Amplitude
+
+amplitude = Amplitude()
+event_data = amplitude.build_event_data(
+    event_type='Some event type',
+    request=request,
+)
+amplitude.send_events([event_data])
+```
+
+The above request will include URL and HTTP header info in the `event_properties`. If you want to override the event properties you can pass them through to `build_event_data`:
+
+```python
+event_data = amplitude.build_event_data(
+    event_type='User purchase',
+    request=request,
+    event_properties={'products': ['laptop', 'phone']}
+)
+```
+
+### build_event_data missing event data keys
+
+The `build_event_data` method (and in extension the `SendPageViewEvent` middleware) currently does not send the following keys from `UploadRequestBody` type in [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2):
+
+* event_id
+* app_version
+* carrier
+* price
+* quantity
+* revenue
+* productId
+* revenueType
+* idfa
+* idfv
+* adid
+* android_id
+* dma
+* insert_id
+
+If you want to record an event in Amplitude with any of these keys you must use build and send your own event data using `amplitude.build_event_data` where you can pass any of the above as kwargs:
+
+```python
+amplitude = Amplitude()
+event_data = amplitude.build_event_data(
+    event_type='Some event type',
+    request=request,
+    app_version='1.0.0',
+)
+amplitude.send_events([event_data])
+```
+
+
+### Building you own event
+
+If you are not happy with the data from `build_event_data` you can build you own event data based on the `UploadRequestBody` type in [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2). If you want to do this There are a few helper functions to build different parts of the event data from the Django request object:
+
+```python
+amplitude.event_properties_from_request(request)  # Gets URL and HTTP header data
+amplitude.device_data_from_request(request)  # Gets device info from user agent
+amplitude.user_properties_from_request(request)  # Gets info from user model
+amplitude.group_from_request(request)  # Gets the list of groups a user is in
+
+amplitude.location_data_from_ip_address(ip_address)  # Gets location data from IP if GeoIP2 is setup
+```
+
+* `user_properties_from_request` will return an empty dict if `AMPLITUDE_INCLUDE_USER_DATA` is `False`
+* `group_from_request` will return an empty dict if `AMPLITUDE_INCLUDE_GROUP_DATA` is `False`
+
+
+#### Configuration settings
+
+Below are the different settings that can be overridden. To do so place the setting into your `settings.py`.
+
+```python
+# This variable is required when amplitude is added to INSTALLED_APPS
+AMPLITUDE_API_KEY = '<amplitude-project-api-key>'
+
+# If the users Django user information is included in the Amplitude event.
+# This includes - username, email, full_name, is_staff, is_superuser
+AMPLITUDE_INCLUDE_USER_DATA = False
+
+# If the groups the user is a member of is included in the Amplitude event.
+# A list of the group names will be sent in the request.
+AMPLITUDE_INCLUDE_GROUP_DATA = False
+
+# A list of URLs which `SendPageViewEvent` middleware should not run for.
+# Each item in the list can be either a URL or url name
+AMPLITUDE_IGNORE_URLS = ['home', '/please/ignore/']
+
+# The minimum permitted length for user_id & device_id fields
+# https://developers.amplitude.com/docs/http-api-v2#properties-2
+AMPLITUDE_MIN_ID_LENGTH = None
+```
+
+
+%package -n python3-django-amplitude
+Summary:	Integration between Django and Amplitude
+Provides:	python-django-amplitude
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-django-amplitude
+# Django Amplitude
+
+Integration between Django and [Amplitude.com](https://amplitude.com/) to help send events via the [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2)
+
+
+## Quick start
+
+### Installation
+
+```bash
+pip install django-amplitude
+```
+
+Add `amplitude` to your `INSTALLED_APPS`. If they are not already the Django `sessions` app must also be added:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'django.contrib.sessions',
+    ...
+    'amplitude',
+]
+```
+
+If you do not have it already you must also add the Django `django.contrib.sessions.middleware.SessionMiddleware`. Then add the ampliturde `SessionInfo` middleware after the `SessionMiddleware`:
+```python
+MIDDLEWARE = [
+    ...
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    ...
+    'amplitude.middleware.SessionInfo',
+]
+```
+
+Now set your Amplitude API key and user / group options in your `settings.py`:
+```python
+# Settings > Projects > <Your project> > General > API Key
+AMPLITUDE_API_KEY = '<amplitude-project-api-key>'
+
+# You can also choose if you want to include user and group data (Default False)
+AMPLITUDE_INCLUDE_USER_DATA = False
+AMPLITUDE_INCLUDE_GROUP_DATA = False
+```
+
+*Note: If you want to include user or group data you must ensure the [Django auth is setup correctly](https://docs.djangoproject.com/en/3.0/topics/auth/#installation). This includes adding `django.contrib.auth` and `django.contrib.contenttypes` to `INSTALLED_APPS` and `django.contrib.auth.middleware.AuthenticationMiddleware` to `MIDDLEWARE`*.
+
+
+For more information on the above settings see the [configuration settings](#configuration-settings) section.
+
+
+
+## Usage
+
+### Page view events
+
+If you want to send an event to Amplitude on every page view you can use the django-amplitude `SendPageViewEvent` middleware to your `MIDDLEWARE` in your Django settings.
+
+This will automatically create an event called `Page view` with all the information it's possible to pull from the Django request object such as URL path and parameters, user agent info, IP info, user info etc.
+
+It must be placed after the `amplitude.middleware.SessionInfo` middleware:
+
+```python
+MIDDLEWARE = [
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    ...
+    'amplitude.middleware.SessionInfo',
+    'amplitude.middleware.SendPageViewEvent',
+]
+```
+
+While using `SendPageViewEvent` if there are certain URLs that you do not want to update Amplitude with you can use the `AMPLITUDE_IGNORE_URLS` setting. This setting take a list of relative urls or URL names. Relative URLS most match exactly so need to start with a forward slash (`/`)
+
+```python
+AMPLITUDE_IGNORE_URLS = ['my_url_name', '/testurl']
+```
+
+
+### Sending events manually
+
+If you want to send your own events:
+```python
+from amplitude import Amplitude
+
+amplitude = Amplitude()
+event_data = amplitude.build_event_data(
+    event_type='Some event type',
+    request=request,
+)
+amplitude.send_events([event_data])
+```
+
+The above request will include URL and HTTP header info in the `event_properties`. If you want to override the event properties you can pass them through to `build_event_data`:
+
+```python
+event_data = amplitude.build_event_data(
+    event_type='User purchase',
+    request=request,
+    event_properties={'products': ['laptop', 'phone']}
+)
+```
+
+### build_event_data missing event data keys
+
+The `build_event_data` method (and in extension the `SendPageViewEvent` middleware) currently does not send the following keys from `UploadRequestBody` type in [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2):
+
+* event_id
+* app_version
+* carrier
+* price
+* quantity
+* revenue
+* productId
+* revenueType
+* idfa
+* idfv
+* adid
+* android_id
+* dma
+* insert_id
+
+If you want to record an event in Amplitude with any of these keys you must use build and send your own event data using `amplitude.build_event_data` where you can pass any of the above as kwargs:
+
+```python
+amplitude = Amplitude()
+event_data = amplitude.build_event_data(
+    event_type='Some event type',
+    request=request,
+    app_version='1.0.0',
+)
+amplitude.send_events([event_data])
+```
+
+
+### Building you own event
+
+If you are not happy with the data from `build_event_data` you can build you own event data based on the `UploadRequestBody` type in [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2). If you want to do this There are a few helper functions to build different parts of the event data from the Django request object:
+
+```python
+amplitude.event_properties_from_request(request)  # Gets URL and HTTP header data
+amplitude.device_data_from_request(request)  # Gets device info from user agent
+amplitude.user_properties_from_request(request)  # Gets info from user model
+amplitude.group_from_request(request)  # Gets the list of groups a user is in
+
+amplitude.location_data_from_ip_address(ip_address)  # Gets location data from IP if GeoIP2 is setup
+```
+
+* `user_properties_from_request` will return an empty dict if `AMPLITUDE_INCLUDE_USER_DATA` is `False`
+* `group_from_request` will return an empty dict if `AMPLITUDE_INCLUDE_GROUP_DATA` is `False`
+
+
+#### Configuration settings
+
+Below are the different settings that can be overridden. To do so place the setting into your `settings.py`.
+
+```python
+# This variable is required when amplitude is added to INSTALLED_APPS
+AMPLITUDE_API_KEY = '<amplitude-project-api-key>'
+
+# If the users Django user information is included in the Amplitude event.
+# This includes - username, email, full_name, is_staff, is_superuser
+AMPLITUDE_INCLUDE_USER_DATA = False
+
+# If the groups the user is a member of is included in the Amplitude event.
+# A list of the group names will be sent in the request.
+AMPLITUDE_INCLUDE_GROUP_DATA = False
+
+# A list of URLs which `SendPageViewEvent` middleware should not run for.
+# Each item in the list can be either a URL or url name
+AMPLITUDE_IGNORE_URLS = ['home', '/please/ignore/']
+
+# The minimum permitted length for user_id & device_id fields
+# https://developers.amplitude.com/docs/http-api-v2#properties-2
+AMPLITUDE_MIN_ID_LENGTH = None
+```
+
+
+%package help
+Summary:	Development documents and examples for django-amplitude
+Provides:	python3-django-amplitude-doc
+%description help
+# Django Amplitude
+
+Integration between Django and [Amplitude.com](https://amplitude.com/) to help send events via the [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2)
+
+
+## Quick start
+
+### Installation
+
+```bash
+pip install django-amplitude
+```
+
+Add `amplitude` to your `INSTALLED_APPS`. If they are not already the Django `sessions` app must also be added:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'django.contrib.sessions',
+    ...
+    'amplitude',
+]
+```
+
+If you do not have it already you must also add the Django `django.contrib.sessions.middleware.SessionMiddleware`. Then add the ampliturde `SessionInfo` middleware after the `SessionMiddleware`:
+```python
+MIDDLEWARE = [
+    ...
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    ...
+    'amplitude.middleware.SessionInfo',
+]
+```
+
+Now set your Amplitude API key and user / group options in your `settings.py`:
+```python
+# Settings > Projects > <Your project> > General > API Key
+AMPLITUDE_API_KEY = '<amplitude-project-api-key>'
+
+# You can also choose if you want to include user and group data (Default False)
+AMPLITUDE_INCLUDE_USER_DATA = False
+AMPLITUDE_INCLUDE_GROUP_DATA = False
+```
+
+*Note: If you want to include user or group data you must ensure the [Django auth is setup correctly](https://docs.djangoproject.com/en/3.0/topics/auth/#installation). This includes adding `django.contrib.auth` and `django.contrib.contenttypes` to `INSTALLED_APPS` and `django.contrib.auth.middleware.AuthenticationMiddleware` to `MIDDLEWARE`*.
+
+
+For more information on the above settings see the [configuration settings](#configuration-settings) section.
+
+
+
+## Usage
+
+### Page view events
+
+If you want to send an event to Amplitude on every page view you can use the django-amplitude `SendPageViewEvent` middleware to your `MIDDLEWARE` in your Django settings.
+
+This will automatically create an event called `Page view` with all the information it's possible to pull from the Django request object such as URL path and parameters, user agent info, IP info, user info etc.
+
+It must be placed after the `amplitude.middleware.SessionInfo` middleware:
+
+```python
+MIDDLEWARE = [
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    ...
+    'amplitude.middleware.SessionInfo',
+    'amplitude.middleware.SendPageViewEvent',
+]
+```
+
+While using `SendPageViewEvent` if there are certain URLs that you do not want to update Amplitude with you can use the `AMPLITUDE_IGNORE_URLS` setting. This setting take a list of relative urls or URL names. Relative URLS most match exactly so need to start with a forward slash (`/`)
+
+```python
+AMPLITUDE_IGNORE_URLS = ['my_url_name', '/testurl']
+```
+
+
+### Sending events manually
+
+If you want to send your own events:
+```python
+from amplitude import Amplitude
+
+amplitude = Amplitude()
+event_data = amplitude.build_event_data(
+    event_type='Some event type',
+    request=request,
+)
+amplitude.send_events([event_data])
+```
+
+The above request will include URL and HTTP header info in the `event_properties`. If you want to override the event properties you can pass them through to `build_event_data`:
+
+```python
+event_data = amplitude.build_event_data(
+    event_type='User purchase',
+    request=request,
+    event_properties={'products': ['laptop', 'phone']}
+)
+```
+
+### build_event_data missing event data keys
+
+The `build_event_data` method (and in extension the `SendPageViewEvent` middleware) currently does not send the following keys from `UploadRequestBody` type in [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2):
+
+* event_id
+* app_version
+* carrier
+* price
+* quantity
+* revenue
+* productId
+* revenueType
+* idfa
+* idfv
+* adid
+* android_id
+* dma
+* insert_id
+
+If you want to record an event in Amplitude with any of these keys you must use build and send your own event data using `amplitude.build_event_data` where you can pass any of the above as kwargs:
+
+```python
+amplitude = Amplitude()
+event_data = amplitude.build_event_data(
+    event_type='Some event type',
+    request=request,
+    app_version='1.0.0',
+)
+amplitude.send_events([event_data])
+```
+
+
+### Building you own event
+
+If you are not happy with the data from `build_event_data` you can build you own event data based on the `UploadRequestBody` type in [Amplitude HTTP API (v2)](https://developers.amplitude.com/docs/http-api-v2). If you want to do this There are a few helper functions to build different parts of the event data from the Django request object:
+
+```python
+amplitude.event_properties_from_request(request)  # Gets URL and HTTP header data
+amplitude.device_data_from_request(request)  # Gets device info from user agent
+amplitude.user_properties_from_request(request)  # Gets info from user model
+amplitude.group_from_request(request)  # Gets the list of groups a user is in
+
+amplitude.location_data_from_ip_address(ip_address)  # Gets location data from IP if GeoIP2 is setup
+```
+
+* `user_properties_from_request` will return an empty dict if `AMPLITUDE_INCLUDE_USER_DATA` is `False`
+* `group_from_request` will return an empty dict if `AMPLITUDE_INCLUDE_GROUP_DATA` is `False`
+
+
+#### Configuration settings
+
+Below are the different settings that can be overridden. To do so place the setting into your `settings.py`.
+
+```python
+# This variable is required when amplitude is added to INSTALLED_APPS
+AMPLITUDE_API_KEY = '<amplitude-project-api-key>'
+
+# If the users Django user information is included in the Amplitude event.
+# This includes - username, email, full_name, is_staff, is_superuser
+AMPLITUDE_INCLUDE_USER_DATA = False
+
+# If the groups the user is a member of is included in the Amplitude event.
+# A list of the group names will be sent in the request.
+AMPLITUDE_INCLUDE_GROUP_DATA = False
+
+# A list of URLs which `SendPageViewEvent` middleware should not run for.
+# Each item in the list can be either a URL or url name
+AMPLITUDE_IGNORE_URLS = ['home', '/please/ignore/']
+
+# The minimum permitted length for user_id & device_id fields
+# https://developers.amplitude.com/docs/http-api-v2#properties-2
+AMPLITUDE_MIN_ID_LENGTH = None
+```
+
+
+%prep
+%autosetup -n django-amplitude-0.7.1
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-django-amplitude -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.1-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..e59a17d
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+cd1774915ba48b2d06e145444b3850c5  django-amplitude-0.7.1.tar.gz