From 470b4f7d41c6057c08e38a429862ae918c1a8635 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Sat, 15 Apr 2023 16:16:30 -0700 Subject: [PATCH 01/16] add authentication and some test Views for market --- .gitignore | 548 ++++++++++++++++++ project/__init__.py | 0 project/core/__init__.py | 0 project/core/admin.py | 25 + project/core/apps.py | 6 + project/core/forms.py | 15 + project/core/migrations/0001_initial.py | 44 ++ ...r_kucoin_api_key_user_kucoin_api_secret.py | 23 + .../migrations/0003_user_kucoin_passphrase.py | 18 + project/core/migrations/__init__.py | 0 project/core/models.py | 11 + project/core/serializers.py | 14 + project/core/tests.py | 3 + project/core/views.py | 3 + project/manage.py | 22 + project/position/__init__.py | 0 project/position/admin.py | 3 + project/position/apps.py | 6 + project/position/migrations/0001_initial.py | 26 + ...mark_price_position_mark_value_and_more.py | 33 ++ ...3_rename_rist_limit_position_risk_limit.py | 18 + project/position/migrations/__init__.py | 0 project/position/models.py | 11 + project/position/serializers.py | 24 + project/position/tests.py | 3 + project/position/urls.py | 8 + project/position/views.py | 32 + project/project/__init__.py | 0 project/project/api_utility.py | 92 +++ project/project/asgi.py | 16 + project/project/settings.py | 161 +++++ project/project/urls.py | 31 + project/project/wsgi.py | 16 + project/requirments.txt | 41 ++ project/utils/__init__.py | 0 requirments.txt | 40 ++ 36 files changed, 1293 insertions(+) create mode 100644 .gitignore create mode 100644 project/__init__.py create mode 100644 project/core/__init__.py create mode 100644 project/core/admin.py create mode 100644 project/core/apps.py create mode 100644 project/core/forms.py create mode 100644 project/core/migrations/0001_initial.py create mode 100644 project/core/migrations/0002_user_kucoin_api_key_user_kucoin_api_secret.py create mode 100644 project/core/migrations/0003_user_kucoin_passphrase.py create mode 100644 project/core/migrations/__init__.py create mode 100644 project/core/models.py create mode 100644 project/core/serializers.py create mode 100644 project/core/tests.py create mode 100644 project/core/views.py create mode 100644 project/manage.py create mode 100644 project/position/__init__.py create mode 100644 project/position/admin.py create mode 100644 project/position/apps.py create mode 100644 project/position/migrations/0001_initial.py create mode 100644 project/position/migrations/0002_position_mark_price_position_mark_value_and_more.py create mode 100644 project/position/migrations/0003_rename_rist_limit_position_risk_limit.py create mode 100644 project/position/migrations/__init__.py create mode 100644 project/position/models.py create mode 100644 project/position/serializers.py create mode 100644 project/position/tests.py create mode 100644 project/position/urls.py create mode 100644 project/position/views.py create mode 100644 project/project/__init__.py create mode 100644 project/project/api_utility.py create mode 100644 project/project/asgi.py create mode 100644 project/project/settings.py create mode 100644 project/project/urls.py create mode 100644 project/project/wsgi.py create mode 100644 project/requirments.txt create mode 100644 project/utils/__init__.py create mode 100644 requirments.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..100fe35 --- /dev/null +++ b/.gitignore @@ -0,0 +1,548 @@ +# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,virtualenv,venv +# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,virtualenv,venv + +### PyCharm ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### PyCharm Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 + +# *.iml +# modules.xml +# .idea/misc.xml +# *.ipr + +# Sonarlint plugin +# https://plugins.jetbrains.com/plugin/7973-sonarlint +.idea/**/sonarlint/ + +# SonarQube Plugin +# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin +.idea/**/sonarIssues.xml + +# Markdown Navigator plugin +# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced +.idea/**/markdown-navigator.xml +.idea/**/markdown-navigator-enh.xml +.idea/**/markdown-navigator/ + +# Cache file creation bug +# See https://youtrack.jetbrains.com/issue/JBR-2257 +.idea/$CACHE_FILE$ + +# CodeStream plugin +# https://plugins.jetbrains.com/plugin/12206-codestream +.idea/codestream.xml + +# Azure Toolkit for IntelliJ plugin +# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij +.idea/**/azureSettings.xml + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +### venv ### +# Virtualenv +# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ +[Bb]in +[Ii]nclude +[Ll]ib +[Ll]ib64 +[Ll]ocal +[Ss]cripts +pyvenv.cfg +pip-selfcheck.json + +### VirtualEnv ### +# Virtualenv +# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ + +# End of https://www.toptal.com/developers/gitignore/api/python,pycharm,virtualenv,venv +Hello! How can I assist you today? + +Text from your selection +Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,virtualenv,venv +Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,virtualenv,venv +PyCharm +Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 +User-specific stuff +.idea//workspace.xml .idea//tasks.xml .idea//usage.statistics.xml .idea//dictionaries .idea/**/shelf + +AWS User-specific +.idea/**/aws.xml + +Generated files +.idea/**/contentModel.xml + +Sensitive or high-churn files +.idea//dataSources/ .idea//dataSources.ids .idea//dataSources.local.xml .idea//sqlDataSources.xml .idea//dynamic.xml .idea//uiDesigner.xml .idea/**/dbnavigator.xml + +Gradle +.idea//gradle.xml .idea//libraries + +Gradle and Maven with auto-import +When using Gradle or Maven with auto-import, you should exclude module files, +since they will be recreated, and may cause churn. Uncomment if using +auto-import. +.idea/artifacts +.idea/compiler.xml +.idea/jarRepositories.xml +.idea/modules.xml +.idea/*.iml +.idea/modules +*.iml +*.ipr +CMake +cmake-build-*/ + +Mongo Explorer plugin +.idea/**/mongoSettings.xml + +File-based project format +*.iws + +IntelliJ +out/ + +mpeltonen/sbt-idea plugin +.idea_modules/ + +JIRA plugin +atlassian-ide-plugin.xml + +Cursive Clojure plugin +.idea/replstate.xml + +SonarLint plugin +.idea/sonarlint/ + +Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml crashlytics.properties crashlytics-build.properties fabric.properties + +Editor-based Rest Client +.idea/httpRequests + +Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +PyCharm Patch +Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 +*.iml +modules.xml +.idea/misc.xml +*.ipr +Sonarlint plugin +https://plugins.jetbrains.com/plugin/7973-sonarlint +.idea/**/sonarlint/ + +SonarQube Plugin +https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin +.idea/**/sonarIssues.xml + +Markdown Navigator plugin +https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced +.idea//markdown-navigator.xml .idea//markdown-navigator-enh.xml .idea/**/markdown-navigator/ + +Cache file creation bug +See https://youtrack.jetbrains.com/issue/JBR-2257 +.idea/ +� +� +� +� +� +� +� +� +� +CACHE +F +​ + ILE + +CodeStream plugin +https://plugins.jetbrains.com/plugin/12206-codestream +.idea/codestream.xml + +Azure Toolkit for IntelliJ plugin +https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij +.idea/**/azureSettings.xml + +Python +Byte-compiled / optimized / DLL files +pycache/ *.py[cod] *$py.class + +C extensions +*.so + +Distribution / packaging +.Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST + +PyInstaller +Usually these files are written by a python script from a template +before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest *.spec + +Installer logs +pip-log.txt pip-delete-this-directory.txt + +Unit test / coverage reports +htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ cover/ + +Translations +*.mo *.pot + +Django stuff: +*.log local_settings.py db.sqlite3 db.sqlite3-journal + +Flask stuff: +instance/ .webassets-cache + +Scrapy stuff: +.scrapy + +Sphinx documentation +docs/_build/ + +PyBuilder +.pybuilder/ target/ + +Jupyter Notebook +.ipynb_checkpoints + +IPython +profile_default/ ipython_config.py + +pyenv +For a library or package, you might want to ignore these files since the code is +intended to run in multiple environments; otherwise, check them in: +.python-version +pipenv +According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +However, in case of collaboration, if having platform-specific dependencies or dependencies +having no cross-platform support, pipenv may install dependencies that don't work, or not +install all needed dependencies. +#Pipfile.lock + +poetry +Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +This is especially recommended for binary packages to ensure reproducibility, and is more +commonly ignored for libraries. +https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +pdm +Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock + +pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +in version control. +https://pdm.fming.dev/#use-with-ide +.pdm.toml + +PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +pypackages/ + +Celery stuff +celerybeat-schedule celerybeat.pid + +SageMath parsed files +*.sage.py + +Environments +.env .venv env/ venv/ ENV/ env.bak/ venv.bak/ + +Spyder project settings +.spyderproject .spyproject + +Rope project settings +.ropeproject + +mkdocs documentation +/site + +mypy +.mypy_cache/ .dmypy.json dmypy.json + +Pyre type checker +.pyre/ + +pytype static type analyzer +.pytype/ + +Cython debug symbols +cython_debug/ + +PyCharm +JetBrains specific template is maintained in a separate JetBrains.gitignore that can +be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +and can be added to the global gitignore or merged into this file. For a more nuclear +option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +Python Patch +Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +ruff +.ruff_cache/ + +LSP config files +pyrightconfig.json + +venv +Virtualenv +http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ +[Bb]in [Ii]nclude [Ll]ib [Ll]ib64 [Ll]ocal [Ss]cripts pyvenv.cfg pip-selfcheck.json + +VirtualEnv +Virtualenv +http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ +End of https://www.toptal.com/developers/gitignore/api/python,pycharm,virtualenv,venv +What would you like to do with the text? \ No newline at end of file diff --git a/project/__init__.py b/project/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/project/core/__init__.py b/project/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/project/core/admin.py b/project/core/admin.py new file mode 100644 index 0000000..e08957a --- /dev/null +++ b/project/core/admin.py @@ -0,0 +1,25 @@ +from django.contrib import admin +from .models import User +from django.contrib.auth.admin import UserAdmin as BaseUserAdmin +from .forms import UserCreationForm, UserChangeForm + + +# Register your models here. + +# @admin.register(User) +class UserAdmin(BaseUserAdmin): + form = UserChangeForm + add_form = UserCreationForm + + add_fieldsets = ( + (None, { + 'classes': ('wide',), + 'fields': ('username', 'password1', 'password2', 'email', 'first_name', 'last_name'), + }), + ) + + list_display = ("username", "email", "first_name", "last_name", "is_staff", "is_active",) + list_filter = ("is_staff", "is_superuser", "is_active", "groups") + + +admin.site.register(User, UserAdmin) diff --git a/project/core/apps.py b/project/core/apps.py new file mode 100644 index 0000000..8115ae6 --- /dev/null +++ b/project/core/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class CoreConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'core' diff --git a/project/core/forms.py b/project/core/forms.py new file mode 100644 index 0000000..806cbc7 --- /dev/null +++ b/project/core/forms.py @@ -0,0 +1,15 @@ +from django.contrib.auth.forms import UserCreationForm, UserChangeForm + +from .models import User + + +class UserCreationForm(UserCreationForm): + class Meta: + model = User + fields = ('email',) + + +class UserChangeForm(UserChangeForm): + class Meta: + model = User + fields = ('email',) diff --git a/project/core/migrations/0001_initial.py b/project/core/migrations/0001_initial.py new file mode 100644 index 0000000..80c6383 --- /dev/null +++ b/project/core/migrations/0001_initial.py @@ -0,0 +1,44 @@ +# Generated by Django 4.2 on 2023-04-15 10:30 + +import django.contrib.auth.models +import django.contrib.auth.validators +from django.db import migrations, models +import django.utils.timezone + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ('auth', '0012_alter_user_first_name_max_length'), + ] + + operations = [ + migrations.CreateModel( + name='User', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('password', models.CharField(max_length=128, verbose_name='password')), + ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')), + ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')), + ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')), + ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')), + ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')), + ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')), + ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')), + ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')), + ('email', models.EmailField(max_length=254, unique=True, verbose_name='email address')), + ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups')), + ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')), + ], + options={ + 'verbose_name': 'user', + 'verbose_name_plural': 'users', + 'abstract': False, + }, + managers=[ + ('objects', django.contrib.auth.models.UserManager()), + ], + ), + ] diff --git a/project/core/migrations/0002_user_kucoin_api_key_user_kucoin_api_secret.py b/project/core/migrations/0002_user_kucoin_api_key_user_kucoin_api_secret.py new file mode 100644 index 0000000..72ee065 --- /dev/null +++ b/project/core/migrations/0002_user_kucoin_api_key_user_kucoin_api_secret.py @@ -0,0 +1,23 @@ +# Generated by Django 4.2 on 2023-04-15 10:33 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('core', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='user', + name='kucoin_api_key', + field=models.CharField(blank=True, max_length=255, null=True), + ), + migrations.AddField( + model_name='user', + name='kucoin_api_secret', + field=models.CharField(blank=True, max_length=255, null=True), + ), + ] diff --git a/project/core/migrations/0003_user_kucoin_passphrase.py b/project/core/migrations/0003_user_kucoin_passphrase.py new file mode 100644 index 0000000..c2e8cc3 --- /dev/null +++ b/project/core/migrations/0003_user_kucoin_passphrase.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2 on 2023-04-15 21:07 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('core', '0002_user_kucoin_api_key_user_kucoin_api_secret'), + ] + + operations = [ + migrations.AddField( + model_name='user', + name='kucoin_passphrase', + field=models.CharField(blank=True, max_length=255, null=True), + ), + ] diff --git a/project/core/migrations/__init__.py b/project/core/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/project/core/models.py b/project/core/models.py new file mode 100644 index 0000000..661362a --- /dev/null +++ b/project/core/models.py @@ -0,0 +1,11 @@ +from django.db import models +from django.contrib.auth.models import AbstractUser +from django.utils.translation import gettext as _ + + +# provide name, username & kucoin details +class User(AbstractUser): + kucoin_api_key = models.CharField(max_length=255, null=True, blank=True) + kucoin_api_secret = models.CharField(max_length=255, null=True, blank=True) + kucoin_passphrase = models.CharField(max_length=255, blank=True, null=True) + email = models.EmailField(_('email address'), unique=True) diff --git a/project/core/serializers.py b/project/core/serializers.py new file mode 100644 index 0000000..07785d9 --- /dev/null +++ b/project/core/serializers.py @@ -0,0 +1,14 @@ +from djoser.serializers import UserCreateSerializer as BaseUserCreateSerializer, UserSerializer as BaseUserSerializer +from rest_framework import serializers + + +class UserCreateSerializer(BaseUserCreateSerializer): + class Meta(BaseUserCreateSerializer.Meta): + fields = ['id', 'first_name', 'last_name', 'email', 'password', 'username', + 'kucoin_api_key', 'kucoin_api_secret', 'kucoin_passphrase'] + + +class UserSerializer(BaseUserSerializer): + class Meta(BaseUserSerializer.Meta): + fields = ['id', 'first_name', 'last_name', 'username', + 'kucoin_api_key', 'kucoin_api_secret', 'kucoin_passphrase'] diff --git a/project/core/tests.py b/project/core/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/project/core/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/project/core/views.py b/project/core/views.py new file mode 100644 index 0000000..91ea44a --- /dev/null +++ b/project/core/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here. diff --git a/project/manage.py b/project/manage.py new file mode 100644 index 0000000..2c49f3a --- /dev/null +++ b/project/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/project/position/__init__.py b/project/position/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/project/position/admin.py b/project/position/admin.py new file mode 100644 index 0000000..8c38f3f --- /dev/null +++ b/project/position/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/project/position/apps.py b/project/position/apps.py new file mode 100644 index 0000000..d6844dc --- /dev/null +++ b/project/position/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class PositionConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'position' diff --git a/project/position/migrations/0001_initial.py b/project/position/migrations/0001_initial.py new file mode 100644 index 0000000..bb3ed45 --- /dev/null +++ b/project/position/migrations/0001_initial.py @@ -0,0 +1,26 @@ +# Generated by Django 4.2 on 2023-04-15 10:43 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + operations = [ + migrations.CreateModel( + name='Position', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('symbol', models.CharField(max_length=10)), + ('created_at', models.DateTimeField(auto_now_add=True)), + ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), + ], + ), + ] diff --git a/project/position/migrations/0002_position_mark_price_position_mark_value_and_more.py b/project/position/migrations/0002_position_mark_price_position_mark_value_and_more.py new file mode 100644 index 0000000..c7b7e93 --- /dev/null +++ b/project/position/migrations/0002_position_mark_price_position_mark_value_and_more.py @@ -0,0 +1,33 @@ +# Generated by Django 4.2 on 2023-04-15 17:20 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('position', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='position', + name='mark_price', + field=models.FloatField(max_length=2, null=True), + ), + migrations.AddField( + model_name='position', + name='mark_value', + field=models.FloatField(max_length=2, null=True), + ), + migrations.AddField( + model_name='position', + name='rist_limit', + field=models.IntegerField(null=True), + ), + migrations.AlterField( + model_name='position', + name='symbol', + field=models.CharField(default='XBTUSDM', max_length=10), + ), + ] diff --git a/project/position/migrations/0003_rename_rist_limit_position_risk_limit.py b/project/position/migrations/0003_rename_rist_limit_position_risk_limit.py new file mode 100644 index 0000000..7b2a01c --- /dev/null +++ b/project/position/migrations/0003_rename_rist_limit_position_risk_limit.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2 on 2023-04-15 23:09 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('position', '0002_position_mark_price_position_mark_value_and_more'), + ] + + operations = [ + migrations.RenameField( + model_name='position', + old_name='rist_limit', + new_name='risk_limit', + ), + ] diff --git a/project/position/migrations/__init__.py b/project/position/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/project/position/models.py b/project/position/models.py new file mode 100644 index 0000000..78d3d69 --- /dev/null +++ b/project/position/models.py @@ -0,0 +1,11 @@ +from django.conf import settings +from django.db import models + + +class Position(models.Model): + user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE) + symbol = models.CharField(max_length=10, default='XBTUSDM') + created_at = models.DateTimeField(auto_now_add=True) + mark_price = models.FloatField(max_length=2,null=True) + mark_value = models.FloatField(max_length=2, null=True) + risk_limit = models.IntegerField(null=True) diff --git a/project/position/serializers.py b/project/position/serializers.py new file mode 100644 index 0000000..db8810b --- /dev/null +++ b/project/position/serializers.py @@ -0,0 +1,24 @@ +from rest_framework import serializers + +from .models import Position + + +class PositionSerializer(serializers.ModelSerializer): + user_id = serializers.IntegerField() + + class Meta: + model = Position + fields = '__all__' + # exclude = ('user',) + read_only_fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'rist_limit') + + +class TrackingPositionSerializer(serializers.ModelSerializer): + + class Meta: + model = Position + fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'risk_limit') + + def create(self, validated_data): + user_id = self.context.get('user_id') + return Position.objects.create(user_id=user_id, **validated_data) diff --git a/project/position/tests.py b/project/position/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/project/position/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/project/position/urls.py b/project/position/urls.py new file mode 100644 index 0000000..3f18766 --- /dev/null +++ b/project/position/urls.py @@ -0,0 +1,8 @@ +from django.urls import path +from . import views + +urlpatterns = [ + path('position_tracking/', views.PositionTrackingView.as_view(), name='position_tracking'), + path('position/', views.OpenPositionsView.as_view(), name='open_positions'), + +] diff --git a/project/position/views.py b/project/position/views.py new file mode 100644 index 0000000..f841b22 --- /dev/null +++ b/project/position/views.py @@ -0,0 +1,32 @@ +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response +from rest_framework.views import APIView + +from .models import Position +from .serializers import PositionSerializer, TrackingPositionSerializer +from project.api_utility import Utility + + +class PositionTrackingView(APIView): + permission_classes = [IsAuthenticated] + + def post(self, request): + # code to start position tracking for the authenticated user + user = request.user + + serializer = TrackingPositionSerializer(data=Utility(user=user).output, + context={'user_id': user.pk}) + serializer.is_valid(raise_exception=True) + serializer.save() + return Response(serializer.data) + # return Response({'detail': 'Position tracking started.'}) + + +class OpenPositionsView(APIView): + permission_classes = [IsAuthenticated] + + def get(self, request): + user = request.user + positions = Position.objects.filter(user=user) + serializer = PositionSerializer(positions, many=True) + return Response(serializer.data) diff --git a/project/project/__init__.py b/project/project/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/project/project/api_utility.py b/project/project/api_utility.py new file mode 100644 index 0000000..32e5f7f --- /dev/null +++ b/project/project/api_utility.py @@ -0,0 +1,92 @@ +# tasks.py +import re +import requests +import time +import hmac +import hashlib +import base64 +from dataclasses import dataclass +import pprint +from django.core.cache import cache +from datetime import timedelta + + +# from django.contrib.auth import get_user_model +# +# User = get_user_model() + + +# from celery import shared_task + +# +# # @shared_task +# def track_positions(user_id): +# # get user details from the database +# user = CustomUser.objects.get(id=user_id) +# +# # connect to KuCoin API +# client = kucoin.client.User(api_key=user.kucoin_api_key, api_secret=user.kucoin_api_secret) +# +# # track positions every 30 seconds +# while True: +# # get open positions +# positions = client.get_open_positions() +# +# # update cache with positions data +# cache_key = f'user_{user_id}_positions' +# cache.set(cache_key, positions, timeout=timedelta(seconds=30)) +# +# # sleep for 30 seconds +# time.sleep(30) + +@dataclass +class Utility: + camel_pat = re.compile(r'([A-Z])') + under_pat = re.compile(r'_([a-z])') + + api_key: str = None + api_secret: str = None + api_passphrase: str = None + user: object = None + output: dict = None + + def __post_init__(self): + self.api_key = self.api_key or self.user.kucoin_api_key + self.api_secret = self.api_secret or self.user.kucoin_api_secret + self.api_passphrase = self.api_passphrase or self.user.kucoin_passphrase + self.output = self.get_positions() + + def _camel_to_underscore(self, name: str) -> str: + return self.camel_pat.sub(lambda x: '_' + x.group(1).lower(), name) + + def _internal_value(self, data: dict) -> dict: + return {self._camel_to_underscore(k): v for k, v in data.items()} + + def get_positions(self) -> dict: + url = 'https://api-futures.kucoin.com/api/v1/position?symbol=XBTUSDM' + now = int(time.time() * 1000) + str_to_sign = str(now) + 'GET' + '/api/v1/position?symbol=XBTUSDM' + signature = base64.b64encode( + hmac.new(self.api_secret.encode('utf-8'), str_to_sign.encode('utf-8'), hashlib.sha256).digest()) + passphrase = base64.b64encode( + hmac.new(self.api_secret.encode('utf-8'), self.api_passphrase.encode('utf-8'), hashlib.sha256).digest()) + headers = { + "KC-API-SIGN": signature, + "KC-API-TIMESTAMP": str(now), + "KC-API-KEY": self.api_key, + "KC-API-PASSPHRASE": passphrase, + "KC-API-KEY-VERSION": "2" + } + response = requests.request('get', url, headers=headers) + pprint.pprint(response.status_code) + pprint.pprint(response.json()) + return self._internal_value(data=response.json()['data']) + + +if __name__ == '__main__': + output = Utility(api_key="643ac410317fa70001647b44", + api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", + api_passphrase="9219474").output + pprint.pprint(output) + # + # print({camel_to_underscore(k): v for k, v in data.items()}) diff --git a/project/project/asgi.py b/project/project/asgi.py new file mode 100644 index 0000000..c9e4e67 --- /dev/null +++ b/project/project/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for project project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings') + +application = get_asgi_application() diff --git a/project/project/settings.py b/project/project/settings.py new file mode 100644 index 0000000..1bdd08d --- /dev/null +++ b/project/project/settings.py @@ -0,0 +1,161 @@ +""" +Django settings for project project. + +Generated by 'django-admin startproject' using Django 4.2. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/4.2/ref/settings/ +""" +from datetime import timedelta +from pathlib import Path + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-^#7@^z-^j@$8@!^gb2vn#(*1&&8cp**gub8gi@7z#vrc!c&5_a' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True +INTERNAL_IPS = [ + "127.0.0.1", +] + +AUTH_USER_MODEL = 'core.User' + +ALLOWED_HOSTS = [] + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'rest_framework', + 'djoser', + 'debug_toolbar', + 'core', + 'position', + +] + +MIDDLEWARE = [ + "debug_toolbar.middleware.DebugToolbarMiddleware", + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'project.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'project.wsgi.application' + +# Database +# https://docs.djangoproject.com/en/4.2/ref/settings/#databases + +# DATABASES = { +# 'default': { +# 'ENGINE': 'django.db.backends.sqlite3', +# 'NAME': BASE_DIR / 'db.sqlite3', +# } +# } + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.mysql', + 'NAME': 'crptodb', + 'HOST': 'localhost', + 'USER': 'root', + 'PASSWORD': '12345@Mn' + } +} + + +# Password validation +# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + +# Internationalization +# https://docs.djangoproject.com/en/4.2/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_TZ = True + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/4.2/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' + +REST_FRAMEWORK = { + 'COERCE_DECIMAL_TO_STRING': False, + 'DEFAULT_AUTHENTICATION_CLASSES': ( + 'rest_framework_simplejwt.authentication.JWTAuthentication', + ), +} + +SIMPLE_JWT = { + 'ACCESS_TOKEN_LIFETIME': timedelta(days=4), + 'REFRESH_TOKEN_LIFETIME': timedelta(days=10), + 'AUTH_HEADER_TYPES': ('JWT',), + +} + +DJOSER = { + 'SERIALIZERS': { + 'user_create': 'core.serializers.UserCreateSerializer', + 'user': 'core.serializers.UserSerializer', + } +} diff --git a/project/project/urls.py b/project/project/urls.py new file mode 100644 index 0000000..33b5cb1 --- /dev/null +++ b/project/project/urls.py @@ -0,0 +1,31 @@ +""" +URL configuration for project project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.2/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import path, include + +urlpatterns = [ + path('admin/', admin.site.urls), + + # API endpoints + path('api/', include('position.urls')), + + # Authentication endpoints + path('auth/', include('djoser.urls')), + path('auth/', include('djoser.urls.jwt')), + + path('__debug__/', include('debug_toolbar.urls')), +] diff --git a/project/project/wsgi.py b/project/project/wsgi.py new file mode 100644 index 0000000..6f61a78 --- /dev/null +++ b/project/project/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for project project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings') + +application = get_wsgi_application() diff --git a/project/requirments.txt b/project/requirments.txt new file mode 100644 index 0000000..b791b4b --- /dev/null +++ b/project/requirments.txt @@ -0,0 +1,41 @@ +asgiref==3.6.0 +certifi==2022.12.7 +cffi==1.15.1 +charset-normalizer==3.1.0 +coreapi==2.3.3 +coreschema==0.0.4 +cryptography==40.0.2 +dateparser==1.1.8 +defusedxml==0.7.1 +Django==4.2 +django-debug-toolbar==4.0.0 +django-templated-mail==1.1.1 +djangorestframework==3.14.0 +djangorestframework-simplejwt==4.8.0 +djoser==2.1.0 +idna==3.4 +itypes==1.2.0 +Jinja2==3.1.2 +MarkupSafe==2.1.2 +mysqlclient==2.1.1 +numpy==1.24.2 +oauthlib==3.2.2 +pycparser==2.21 +PyJWT==2.6.0 +python-dateutil==2.8.2 +python-kucoin==0.1.12 +python3-openid==3.2.0 +pytz==2023.3 +pytz-deprecation-shim==0.1.0.post0 +regex==2023.3.23 +requests==2.28.2 +requests-oauthlib==1.3.1 +six==1.16.0 +social-auth-app-django==4.0.0 +social-auth-core==4.4.1 +sqlparse==0.4.3 +tzdata==2023.3 +tzlocal==4.3 +uritemplate==4.1.1 +urllib3==1.26.15 +websockets==11.0.1 diff --git a/project/utils/__init__.py b/project/utils/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/requirments.txt b/requirments.txt new file mode 100644 index 0000000..44f6be5 --- /dev/null +++ b/requirments.txt @@ -0,0 +1,40 @@ +asgiref==3.6.0 +certifi==2022.12.7 +cffi==1.15.1 +charset-normalizer==3.1.0 +coreapi==2.3.3 +coreschema==0.0.4 +cryptography==40.0.2 +dateparser==1.1.8 +defusedxml==0.7.1 +Django==4.2 +django-debug-toolbar==4.0.0 +django-templated-mail==1.1.1 +djangorestframework==3.14.0 +djangorestframework-simplejwt==4.8.0 +djoser==2.1.0 +idna==3.4 +itypes==1.2.0 +Jinja2==3.1.2 +MarkupSafe==2.1.2 +numpy==1.24.2 +oauthlib==3.2.2 +pycparser==2.21 +PyJWT==2.6.0 +python-dateutil==2.8.2 +python-kucoin==0.1.12 +python3-openid==3.2.0 +pytz==2023.3 +pytz-deprecation-shim==0.1.0.post0 +regex==2023.3.23 +requests==2.28.2 +requests-oauthlib==1.3.1 +six==1.16.0 +social-auth-app-django==4.0.0 +social-auth-core==4.4.1 +sqlparse==0.4.3 +tzdata==2023.3 +tzlocal==4.3 +uritemplate==4.1.1 +urllib3==1.26.15 +websockets==11.0.1 From 2d660c2e28c6296a819d901a27b4e427e5e7f4eb Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Mon, 17 Apr 2023 12:20:15 -0700 Subject: [PATCH 02/16] add celery and djago-celery-beat --- project/core/serializers.py | 2 +- project/position/__init__.py | 4 + project/position/celery.py | 13 ++++ .../api_utility.py => position/tasks.py} | 78 +++++++++---------- project/position/views.py | 42 ++++++++-- project/project/settings.py | 13 +++- 6 files changed, 100 insertions(+), 52 deletions(-) create mode 100644 project/position/celery.py rename project/{project/api_utility.py => position/tasks.py} (50%) diff --git a/project/core/serializers.py b/project/core/serializers.py index 07785d9..0fb72df 100644 --- a/project/core/serializers.py +++ b/project/core/serializers.py @@ -10,5 +10,5 @@ class Meta(BaseUserCreateSerializer.Meta): class UserSerializer(BaseUserSerializer): class Meta(BaseUserSerializer.Meta): - fields = ['id', 'first_name', 'last_name', 'username', + fields = ['id', 'first_name', 'last_name', 'username','email', 'kucoin_api_key', 'kucoin_api_secret', 'kucoin_passphrase'] diff --git a/project/position/__init__.py b/project/position/__init__.py index e69de29..88b8c87 100644 --- a/project/position/__init__.py +++ b/project/position/__init__.py @@ -0,0 +1,4 @@ +from .celery import app as celery_app + + +__all__ = ("celery_app",) \ No newline at end of file diff --git a/project/position/celery.py b/project/position/celery.py new file mode 100644 index 0000000..c745c9d --- /dev/null +++ b/project/position/celery.py @@ -0,0 +1,13 @@ +import os +from celery import Celery + +# Set the default Django settings module +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings') + +# Create a Celery instance +app = Celery('project') + +app.config_from_object("django.conf:settings", namespace="CELERY") + +# Load task modules from all registered Django app configs +app.autodiscover_tasks() diff --git a/project/project/api_utility.py b/project/position/tasks.py similarity index 50% rename from project/project/api_utility.py rename to project/position/tasks.py index 32e5f7f..8d8db27 100644 --- a/project/project/api_utility.py +++ b/project/position/tasks.py @@ -7,54 +7,41 @@ import base64 from dataclasses import dataclass import pprint +from .serializers import TrackingPositionSerializer +from celery import shared_task + from django.core.cache import cache from datetime import timedelta -# from django.contrib.auth import get_user_model -# -# User = get_user_model() - - -# from celery import shared_task - -# -# # @shared_task -# def track_positions(user_id): -# # get user details from the database -# user = CustomUser.objects.get(id=user_id) -# -# # connect to KuCoin API -# client = kucoin.client.User(api_key=user.kucoin_api_key, api_secret=user.kucoin_api_secret) -# -# # track positions every 30 seconds -# while True: -# # get open positions -# positions = client.get_open_positions() -# -# # update cache with positions data -# cache_key = f'user_{user_id}_positions' -# cache.set(cache_key, positions, timeout=timedelta(seconds=30)) -# -# # sleep for 30 seconds -# time.sleep(30) - @dataclass class Utility: camel_pat = re.compile(r'([A-Z])') under_pat = re.compile(r'_([a-z])') + serializer = TrackingPositionSerializer + symbol_name: str = 'XBTUSDM' + context: dict = None api_key: str = None api_secret: str = None api_passphrase: str = None - user: object = None + user: dict = None output: dict = None + data: dict = None def __post_init__(self): - self.api_key = self.api_key or self.user.kucoin_api_key - self.api_secret = self.api_secret or self.user.kucoin_api_secret - self.api_passphrase = self.api_passphrase or self.user.kucoin_passphrase + self.api_key = self.api_key or self.user.get('kucoin_api_key') + self.api_secret = self.api_secret or self.user.get('kucoin_api_secret') + self.api_passphrase = self.api_passphrase or self.user.get('kucoin_passphrase') self.output = self.get_positions() + # + self.data = self.serializing_output() + + def serializing_output(self): + s = self.serializer(data=self.output, context=self.context) + s.is_valid(raise_exception=True) + s.save() + return s.data def _camel_to_underscore(self, name: str) -> str: return self.camel_pat.sub(lambda x: '_' + x.group(1).lower(), name) @@ -63,9 +50,9 @@ def _internal_value(self, data: dict) -> dict: return {self._camel_to_underscore(k): v for k, v in data.items()} def get_positions(self) -> dict: - url = 'https://api-futures.kucoin.com/api/v1/position?symbol=XBTUSDM' + url = f'https://api-futures.kucoin.com/api/v1/position?symbol={self.symbol_name}' now = int(time.time() * 1000) - str_to_sign = str(now) + 'GET' + '/api/v1/position?symbol=XBTUSDM' + str_to_sign = str(now) + 'GET' + f'/api/v1/position?symbol={self.symbol_name}' signature = base64.b64encode( hmac.new(self.api_secret.encode('utf-8'), str_to_sign.encode('utf-8'), hashlib.sha256).digest()) passphrase = base64.b64encode( @@ -79,14 +66,21 @@ def get_positions(self) -> dict: } response = requests.request('get', url, headers=headers) pprint.pprint(response.status_code) - pprint.pprint(response.json()) + # pprint.pprint(response.json()) return self._internal_value(data=response.json()['data']) -if __name__ == '__main__': - output = Utility(api_key="643ac410317fa70001647b44", - api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", - api_passphrase="9219474").output - pprint.pprint(output) - # - # print({camel_to_underscore(k): v for k, v in data.items()}) +@shared_task +def tracking_task(user, context): + print("Tracking task---------> START") + obj = Utility(user=user, context=context) + # pprint.pprint(obj.data) + print("Tracking task---------> Done") + +# if __name__ == '__main__': +# output = Utility(api_key="643ac410317fa70001647b44", +# api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", +# api_passphrase="9219474").output +# pprint.pprint(output) +# # +# # print({camel_to_underscore(k): v for k, v in data.items()}) diff --git a/project/position/views.py b/project/position/views.py index f841b22..497c928 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -4,22 +4,48 @@ from .models import Position from .serializers import PositionSerializer, TrackingPositionSerializer -from project.api_utility import Utility +from django_celery_beat.models import PeriodicTask, IntervalSchedule + +from .tasks import Utility, tracking_task +from datetime import datetime, timedelta +import json class PositionTrackingView(APIView): permission_classes = [IsAuthenticated] - def post(self, request): + def post(self, request, symbol_name='XBTUSDM'): # code to start position tracking for the authenticated user + + # tracking_task.delay(user=user_kucoin_secret_items, + # context={'user_id': user.pk}) + # tracking_task.apply_async(kwargs=dict(user=user_kucoin_secret_items, + # context={'user_id': user.pk}), countdown=3, expires=3600) + # + # tracking_task.apply_async(kwargs=dict(user=user_kucoin_secret_items, + # context={'user_id': user.pk}), eta=datetime.now() + timedelta(seconds=3)) user = request.user + user_kucoin_secret_items = {'kucoin_api_key': user.kucoin_api_key, + 'kucoin_api_secret': user.kucoin_api_secret, + 'kucoin_passphrase': user.kucoin_passphrase} - serializer = TrackingPositionSerializer(data=Utility(user=user).output, - context={'user_id': user.pk}) - serializer.is_valid(raise_exception=True) - serializer.save() - return Response(serializer.data) - # return Response({'detail': 'Position tracking started.'}) + + MY_APP_NAME = 'position' + + schedule, created = IntervalSchedule.objects.get_or_create( + every=10, + period=IntervalSchedule.SECONDS, + ) + + PeriodicTask.objects.create( + interval=schedule, # we created this above. + name=f'{user.id}_{symbol_name}', # simply describes this periodic task. (unique) + task=f'{MY_APP_NAME}.tasks.tracking_task', # name of task. + kwargs=json.dumps(dict(user=user_kucoin_secret_items, context={'user_id': user.pk})), + expires=datetime.utcnow() + timedelta(seconds=3600) # expire time + ) + + return Response({'detail': 'Position tracking started.', 'symbol': symbol_name}) class OpenPositionsView(APIView): diff --git a/project/project/settings.py b/project/project/settings.py index 1bdd08d..c1954a8 100644 --- a/project/project/settings.py +++ b/project/project/settings.py @@ -45,6 +45,7 @@ 'debug_toolbar', 'core', 'position', + 'django_celery_beat', ] @@ -99,7 +100,6 @@ } } - # Password validation # https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators @@ -159,3 +159,14 @@ 'user': 'core.serializers.UserSerializer', } } + +#### CELERY ################################# +CELERY_BROKER_URL = 'redis://localhost:6379/0' +CELERY_RESULT_BACKEND = 'redis://localhost:6379/0' + +CELERY_TASK_SERIALIZER = 'json' +CELERY_RESULT_SERIALIZER = 'json' +CELERY_ACCEPT_CONTENT = ['json'] + +##### CELERY_BEAT ############################ +CELERY_BEAT_SCHEDULER = 'django_celery_beat.schedulers:DatabaseScheduler' From 9bee9d831a3e20c596ede7c1db49884943efb567 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Mon, 17 Apr 2023 14:07:46 -0700 Subject: [PATCH 03/16] add try-except for tracking view and add status codes --- project/core/admin.py | 4 +--- project/position/tasks.py | 4 ++-- project/position/views.py | 38 +++++++++++++++----------------------- 3 files changed, 18 insertions(+), 28 deletions(-) diff --git a/project/core/admin.py b/project/core/admin.py index e08957a..b9b3319 100644 --- a/project/core/admin.py +++ b/project/core/admin.py @@ -6,7 +6,7 @@ # Register your models here. -# @admin.register(User) +@admin.register(User) class UserAdmin(BaseUserAdmin): form = UserChangeForm add_form = UserCreationForm @@ -21,5 +21,3 @@ class UserAdmin(BaseUserAdmin): list_display = ("username", "email", "first_name", "last_name", "is_staff", "is_active",) list_filter = ("is_staff", "is_superuser", "is_active", "groups") - -admin.site.register(User, UserAdmin) diff --git a/project/position/tasks.py b/project/position/tasks.py index 8d8db27..403ed06 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -18,6 +18,7 @@ class Utility: camel_pat = re.compile(r'([A-Z])') under_pat = re.compile(r'_([a-z])') + serializer = None serializer = TrackingPositionSerializer symbol_name: str = 'XBTUSDM' @@ -73,8 +74,7 @@ def get_positions(self) -> dict: @shared_task def tracking_task(user, context): print("Tracking task---------> START") - obj = Utility(user=user, context=context) - # pprint.pprint(obj.data) + Utility(user=user, context=context) print("Tracking task---------> Done") # if __name__ == '__main__': diff --git a/project/position/views.py b/project/position/views.py index 497c928..321e9b7 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -6,7 +6,7 @@ from .serializers import PositionSerializer, TrackingPositionSerializer from django_celery_beat.models import PeriodicTask, IntervalSchedule -from .tasks import Utility, tracking_task +from rest_framework import status from datetime import datetime, timedelta import json @@ -16,36 +16,28 @@ class PositionTrackingView(APIView): def post(self, request, symbol_name='XBTUSDM'): # code to start position tracking for the authenticated user - - # tracking_task.delay(user=user_kucoin_secret_items, - # context={'user_id': user.pk}) - # tracking_task.apply_async(kwargs=dict(user=user_kucoin_secret_items, - # context={'user_id': user.pk}), countdown=3, expires=3600) - # - # tracking_task.apply_async(kwargs=dict(user=user_kucoin_secret_items, - # context={'user_id': user.pk}), eta=datetime.now() + timedelta(seconds=3)) user = request.user user_kucoin_secret_items = {'kucoin_api_key': user.kucoin_api_key, 'kucoin_api_secret': user.kucoin_api_secret, 'kucoin_passphrase': user.kucoin_passphrase} - - MY_APP_NAME = 'position' - + my_app_name = 'position' schedule, created = IntervalSchedule.objects.get_or_create( every=10, period=IntervalSchedule.SECONDS, ) - - PeriodicTask.objects.create( - interval=schedule, # we created this above. - name=f'{user.id}_{symbol_name}', # simply describes this periodic task. (unique) - task=f'{MY_APP_NAME}.tasks.tracking_task', # name of task. - kwargs=json.dumps(dict(user=user_kucoin_secret_items, context={'user_id': user.pk})), - expires=datetime.utcnow() + timedelta(seconds=3600) # expire time - ) - - return Response({'detail': 'Position tracking started.', 'symbol': symbol_name}) + try: + PeriodicTask.objects.create( + interval=schedule, # we created this above. + name=f'{user.id}_{symbol_name}', # simply describes this periodic task. (unique) + task=f'{my_app_name}.tasks.tracking_task', # name of task. + kwargs=json.dumps(dict(user=user_kucoin_secret_items, context={'user_id': user.pk})), + expires=datetime.utcnow() + timedelta(seconds=3600) # expire time + ) + except Exception as err: + return Response({"message": f"Maybe you already set up tracking for symbol = {symbol_name}"}, + status=status.HTTP_409_CONFLICT) + return Response({'message': f'Position tracking started symbol {symbol_name}'}, status=status.HTTP_201_CREATED) class OpenPositionsView(APIView): @@ -53,6 +45,6 @@ class OpenPositionsView(APIView): def get(self, request): user = request.user - positions = Position.objects.filter(user=user) + positions = Position.objects.filter(user=user).order_by('created_at') serializer = PositionSerializer(positions, many=True) return Response(serializer.data) From f0b93b485a82a01a6b311f4ce75c86389d1ee0f6 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 01:30:04 -0700 Subject: [PATCH 04/16] add cache system but it hasn't been tested yet --- project/position/tasks.py | 72 ++++++++++++++++++++++++------------- project/position/views.py | 11 ++++-- project/project/settings.py | 11 ++++++ 3 files changed, 66 insertions(+), 28 deletions(-) diff --git a/project/position/tasks.py b/project/position/tasks.py index 403ed06..f6178f8 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -6,6 +6,7 @@ import hashlib import base64 from dataclasses import dataclass +import json import pprint from .serializers import TrackingPositionSerializer from celery import shared_task @@ -18,10 +19,9 @@ class Utility: camel_pat = re.compile(r'([A-Z])') under_pat = re.compile(r'_([a-z])') - serializer = None serializer = TrackingPositionSerializer - symbol_name: str = 'XBTUSDM' + symbol_name: str = 'XBTUSDM' # or 'XBTUSDT' context: dict = None api_key: str = None api_secret: str = None @@ -36,13 +36,22 @@ def __post_init__(self): self.api_passphrase = self.api_passphrase or self.user.get('kucoin_passphrase') self.output = self.get_positions() # - self.data = self.serializing_output() + self._validated_data = self.serializing_output() + + def _set_cache(self) -> None: + if self._validated_data: + _user_id = self.context.get("user_id") + cache.set(f'cache_key_{_user_id}', json.dumps(self.output), timeout=300) def serializing_output(self): - s = self.serializer(data=self.output, context=self.context) - s.is_valid(raise_exception=True) - s.save() - return s.data + if self.output is not None: + s = self.serializer(data=self.output, context=self.context) + s.is_valid(raise_exception=True) + s.save() + + # self._set_cache() + return s.data + return None def _camel_to_underscore(self, name: str) -> str: return self.camel_pat.sub(lambda x: '_' + x.group(1).lower(), name) @@ -50,10 +59,19 @@ def _camel_to_underscore(self, name: str) -> str: def _internal_value(self, data: dict) -> dict: return {self._camel_to_underscore(k): v for k, v in data.items()} - def get_positions(self) -> dict: + def get_positions(self) -> dict | None: + # For position details url = f'https://api-futures.kucoin.com/api/v1/position?symbol={self.symbol_name}' + # For positions (list of positions) + # url = f'https://api-futures.kucoin.com/api/v1/positions' + now = int(time.time() * 1000) + # For position details str_to_sign = str(now) + 'GET' + f'/api/v1/position?symbol={self.symbol_name}' + + # For positions (list of positions) + # str_to_sign = str(now) + 'GET' + f'/api/v1/positions' + signature = base64.b64encode( hmac.new(self.api_secret.encode('utf-8'), str_to_sign.encode('utf-8'), hashlib.sha256).digest()) passphrase = base64.b64encode( @@ -66,21 +84,25 @@ def get_positions(self) -> dict: "KC-API-KEY-VERSION": "2" } response = requests.request('get', url, headers=headers) - pprint.pprint(response.status_code) - # pprint.pprint(response.json()) - return self._internal_value(data=response.json()['data']) - - -@shared_task -def tracking_task(user, context): - print("Tracking task---------> START") - Utility(user=user, context=context) - print("Tracking task---------> Done") - -# if __name__ == '__main__': -# output = Utility(api_key="643ac410317fa70001647b44", -# api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", -# api_passphrase="9219474").output -# pprint.pprint(output) -# # + + res = response.json() + data = res.get('data') + if data is not None: + return self._internal_value(data=data) + else: + print(res) + return None + +# @shared_task +# def tracking_task(user, context): +# print("Tracking task---------> START") +# Utility(user=user, context=context) +# print("Tracking task---------> Done") + +if __name__ == '__main__': + output = Utility(api_key="643ac410317fa70001647b44", + api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", + api_passphrase="9219474").output + pprint.pprint(output) + # # # print({camel_to_underscore(k): v for k, v in data.items()}) diff --git a/project/position/views.py b/project/position/views.py index 321e9b7..74a769c 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -1,11 +1,10 @@ from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response from rest_framework.views import APIView - from .models import Position from .serializers import PositionSerializer, TrackingPositionSerializer from django_celery_beat.models import PeriodicTask, IntervalSchedule - +from django.core.cache import cache from rest_framework import status from datetime import datetime, timedelta import json @@ -32,11 +31,12 @@ def post(self, request, symbol_name='XBTUSDM'): name=f'{user.id}_{symbol_name}', # simply describes this periodic task. (unique) task=f'{my_app_name}.tasks.tracking_task', # name of task. kwargs=json.dumps(dict(user=user_kucoin_secret_items, context={'user_id': user.pk})), - expires=datetime.utcnow() + timedelta(seconds=3600) # expire time + expires=datetime.utcnow() + timedelta(seconds=3600*24*10) # expire time ) except Exception as err: return Response({"message": f"Maybe you already set up tracking for symbol = {symbol_name}"}, status=status.HTTP_409_CONFLICT) + return Response({'message': f'Position tracking started symbol {symbol_name}'}, status=status.HTTP_201_CREATED) @@ -45,6 +45,11 @@ class OpenPositionsView(APIView): def get(self, request): user = request.user + # Check if the data is already cached + cached_data = cache.get(f'cache_key_{user.id}') + if cached_data: + return Response(cached_data) + positions = Position.objects.filter(user=user).order_by('created_at') serializer = PositionSerializer(positions, many=True) return Response(serializer.data) diff --git a/project/project/settings.py b/project/project/settings.py index c1954a8..308b7ef 100644 --- a/project/project/settings.py +++ b/project/project/settings.py @@ -170,3 +170,14 @@ ##### CELERY_BEAT ############################ CELERY_BEAT_SCHEDULER = 'django_celery_beat.schedulers:DatabaseScheduler' + +##### CACHES ################################# +CACHES = { + 'default': { + 'BACKEND': 'django_redis.cache.RedisCache', + 'LOCATION': 'redis://127.0.0.1:6379/1', + 'OPTIONS': { + 'CLIENT_CLASS': 'django_redis.client.DefaultClient', + } + } +} From 001b4c14a5160a8551422a16448e0c989a5047ed Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 02:50:20 -0700 Subject: [PATCH 05/16] resolve some bugs --- project/position/tasks.py | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/project/position/tasks.py b/project/position/tasks.py index f6178f8..df1410f 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -12,7 +12,7 @@ from celery import shared_task from django.core.cache import cache -from datetime import timedelta + @dataclass @@ -87,22 +87,25 @@ def get_positions(self) -> dict | None: res = response.json() data = res.get('data') - if data is not None: + if data: return self._internal_value(data=data) else: print(res) return None -# @shared_task -# def tracking_task(user, context): -# print("Tracking task---------> START") -# Utility(user=user, context=context) -# print("Tracking task---------> Done") - -if __name__ == '__main__': - output = Utility(api_key="643ac410317fa70001647b44", - api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", - api_passphrase="9219474").output - pprint.pprint(output) +@shared_task +def tracking_task(user, context): + print("Tracking task---------> START") + Utility(user=user, context=context) + print("Tracking task---------> Done") + +# if __name__ == '__main__': + # output = Utility(api_key="643ac410317fa70001647b44", + # api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", + # api_passphrase="9219474").output + # output = Utility(api_key="643e5c90d3b4b7000149c88c", + # api_secret="2e03da19-254e-4556-8055-553c62b4d44c", + # api_passphrase="9219474").output + # pprint.pprint(output) # # # print({camel_to_underscore(k): v for k, v in data.items()}) From 5cc10c5931b3d042b8ea46bd8d490233015b3224 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 05:26:13 -0700 Subject: [PATCH 06/16] check cache system --- project/position/tasks.py | 35 ++++++++++++++++++++--------------- project/position/views.py | 16 +++++++++++++--- project/project/settings.py | 3 +++ 3 files changed, 36 insertions(+), 18 deletions(-) diff --git a/project/position/tasks.py b/project/position/tasks.py index df1410f..e3b65d3 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -10,10 +10,9 @@ import pprint from .serializers import TrackingPositionSerializer from celery import shared_task +from datetime import timedelta -from django.core.cache import cache - - +from django_redis import get_redis_connection @dataclass class Utility: @@ -21,6 +20,7 @@ class Utility: under_pat = re.compile(r'_([a-z])') serializer = TrackingPositionSerializer + redis_conn: object symbol_name: str = 'XBTUSDM' # or 'XBTUSDT' context: dict = None api_key: str = None @@ -31,6 +31,8 @@ class Utility: data: dict = None def __post_init__(self): + # self.redis_client = redis.Redis(host='127.0.0.1', port=6379, db=1) + self.api_key = self.api_key or self.user.get('kucoin_api_key') self.api_secret = self.api_secret or self.user.get('kucoin_api_secret') self.api_passphrase = self.api_passphrase or self.user.get('kucoin_passphrase') @@ -39,9 +41,10 @@ def __post_init__(self): self._validated_data = self.serializing_output() def _set_cache(self) -> None: - if self._validated_data: + if self.output: _user_id = self.context.get("user_id") - cache.set(f'cache_key_{_user_id}', json.dumps(self.output), timeout=300) + self.redis_conn.set(f'cache_key_{_user_id}', json.dumps(self.output)) + self.redis_conn.expire('my_key', timedelta(seconds=300)) def serializing_output(self): if self.output is not None: @@ -49,7 +52,7 @@ def serializing_output(self): s.is_valid(raise_exception=True) s.save() - # self._set_cache() + self._set_cache() return s.data return None @@ -93,19 +96,21 @@ def get_positions(self) -> dict | None: print(res) return None + @shared_task def tracking_task(user, context): + redis_conn = get_redis_connection("default") print("Tracking task---------> START") - Utility(user=user, context=context) + Utility(user=user, context=context, redis_conn=redis_conn) print("Tracking task---------> Done") # if __name__ == '__main__': - # output = Utility(api_key="643ac410317fa70001647b44", - # api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", - # api_passphrase="9219474").output - # output = Utility(api_key="643e5c90d3b4b7000149c88c", - # api_secret="2e03da19-254e-4556-8055-553c62b4d44c", - # api_passphrase="9219474").output - # pprint.pprint(output) - # +# output = Utility(api_key="643ac410317fa70001647b44", +# api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", +# api_passphrase="9219474").output +# output = Utility(api_key="643e5c90d3b4b7000149c88c", +# api_secret="2e03da19-254e-4556-8055-553c62b4d44c", +# api_passphrase="9219474").output +# pprint.pprint(output) +# # # print({camel_to_underscore(k): v for k, v in data.items()}) diff --git a/project/position/views.py b/project/position/views.py index 74a769c..ffbe253 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -4,11 +4,16 @@ from .models import Position from .serializers import PositionSerializer, TrackingPositionSerializer from django_celery_beat.models import PeriodicTask, IntervalSchedule -from django.core.cache import cache +# from django.core.cache import cache +# from django.core.cache import cache + +# from django_redis.cache import cache from rest_framework import status from datetime import datetime, timedelta import json +from django_redis import get_redis_connection + class PositionTrackingView(APIView): permission_classes = [IsAuthenticated] @@ -22,7 +27,7 @@ def post(self, request, symbol_name='XBTUSDM'): my_app_name = 'position' schedule, created = IntervalSchedule.objects.get_or_create( - every=10, + every=30, period=IntervalSchedule.SECONDS, ) try: @@ -44,12 +49,17 @@ class OpenPositionsView(APIView): permission_classes = [IsAuthenticated] def get(self, request): + self._get_redis_conn() user = request.user # Check if the data is already cached - cached_data = cache.get(f'cache_key_{user.id}') + + cached_data = self.redis_conn.get(f'cache_key_{user.id}') if cached_data: return Response(cached_data) positions = Position.objects.filter(user=user).order_by('created_at') serializer = PositionSerializer(positions, many=True) return Response(serializer.data) + + def _get_redis_conn(self): + self.redis_conn = get_redis_connection("default") \ No newline at end of file diff --git a/project/project/settings.py b/project/project/settings.py index 308b7ef..ba6ecd0 100644 --- a/project/project/settings.py +++ b/project/project/settings.py @@ -181,3 +181,6 @@ } } } + + +# REDIS_CACHE_URL = 'redis://127.0.0.1:6379/1' \ No newline at end of file From 75acb369fa5f0800e1a8e34b98d704558602e39b Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 09:32:17 -0700 Subject: [PATCH 07/16] test cache and resovle bugs for setting cache in tasks.py --- project/position/serializers.py | 14 ++++++++------ project/position/tasks.py | 5 +---- project/position/views.py | 31 +++++++++++++++++++------------ 3 files changed, 28 insertions(+), 22 deletions(-) diff --git a/project/position/serializers.py b/project/position/serializers.py index db8810b..902fc44 100644 --- a/project/position/serializers.py +++ b/project/position/serializers.py @@ -4,14 +4,16 @@ class PositionSerializer(serializers.ModelSerializer): - user_id = serializers.IntegerField() - + # user_id = serializers.IntegerField() + # + # class Meta: + # model = Position + # fields = '__all__' + # # exclude = ('user',) + # read_only_fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'rist_limit') class Meta: model = Position - fields = '__all__' - # exclude = ('user',) - read_only_fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'rist_limit') - + fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'risk_limit') class TrackingPositionSerializer(serializers.ModelSerializer): diff --git a/project/position/tasks.py b/project/position/tasks.py index e3b65d3..057af5d 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -1,4 +1,3 @@ -# tasks.py import re import requests import time @@ -31,8 +30,6 @@ class Utility: data: dict = None def __post_init__(self): - # self.redis_client = redis.Redis(host='127.0.0.1', port=6379, db=1) - self.api_key = self.api_key or self.user.get('kucoin_api_key') self.api_secret = self.api_secret or self.user.get('kucoin_api_secret') self.api_passphrase = self.api_passphrase or self.user.get('kucoin_passphrase') @@ -44,7 +41,7 @@ def _set_cache(self) -> None: if self.output: _user_id = self.context.get("user_id") self.redis_conn.set(f'cache_key_{_user_id}', json.dumps(self.output)) - self.redis_conn.expire('my_key', timedelta(seconds=300)) + self.redis_conn.expire(f'cache_key_{_user_id}', timedelta(seconds=25)) def serializing_output(self): if self.output is not None: diff --git a/project/position/views.py b/project/position/views.py index ffbe253..13a64fb 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -4,10 +4,6 @@ from .models import Position from .serializers import PositionSerializer, TrackingPositionSerializer from django_celery_beat.models import PeriodicTask, IntervalSchedule -# from django.core.cache import cache -# from django.core.cache import cache - -# from django_redis.cache import cache from rest_framework import status from datetime import datetime, timedelta import json @@ -36,7 +32,7 @@ def post(self, request, symbol_name='XBTUSDM'): name=f'{user.id}_{symbol_name}', # simply describes this periodic task. (unique) task=f'{my_app_name}.tasks.tracking_task', # name of task. kwargs=json.dumps(dict(user=user_kucoin_secret_items, context={'user_id': user.pk})), - expires=datetime.utcnow() + timedelta(seconds=3600*24*10) # expire time + expires=datetime.utcnow() + timedelta(days=100) # expire time ) except Exception as err: return Response({"message": f"Maybe you already set up tracking for symbol = {symbol_name}"}, @@ -47,19 +43,30 @@ def post(self, request, symbol_name='XBTUSDM'): class OpenPositionsView(APIView): permission_classes = [IsAuthenticated] + serializer_class = PositionSerializer def get(self, request): - self._get_redis_conn() user = request.user # Check if the data is already cached - - cached_data = self.redis_conn.get(f'cache_key_{user.id}') + cached_data = self.get_results_from_redis(user=user) if cached_data: - return Response(cached_data) + serializer = self.serializer_class(data=json.loads(cached_data)) + if serializer.is_valid(): + return Response(serializer.data) + else: + return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) + # Fetch data from database. positions = Position.objects.filter(user=user).order_by('created_at') - serializer = PositionSerializer(positions, many=True) + serializer = self.serializer_class(positions, many=True) return Response(serializer.data) - def _get_redis_conn(self): - self.redis_conn = get_redis_connection("default") \ No newline at end of file + def get_results_from_redis(self, user): + result = None + try: + self.redis_conn = get_redis_connection("default") + result = self.redis_conn.get(f'cache_key_{user.id}') + except Exception as e: + # Logger exception + pass + return result From 38d2cd264b554f72ac84d87ca8fe3565e8deba93 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 09:44:33 -0700 Subject: [PATCH 08/16] add try-exceptions --- project/position/tasks.py | 1 - 1 file changed, 1 deletion(-) diff --git a/project/position/tasks.py b/project/position/tasks.py index 057af5d..c30888a 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -93,7 +93,6 @@ def get_positions(self) -> dict | None: print(res) return None - @shared_task def tracking_task(user, context): redis_conn = get_redis_connection("default") From 99e67fe723a452cc86f56d98523ef8e019b39d17 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 09:49:28 -0700 Subject: [PATCH 09/16] update requirments.txt --- requirments.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/requirments.txt b/requirments.txt index 44f6be5..c96f85e 100644 --- a/requirments.txt +++ b/requirments.txt @@ -1,31 +1,51 @@ +amqp==5.1.1 asgiref==3.6.0 +async-timeout==4.0.2 +billiard==3.6.4.0 +celery==5.2.7 certifi==2022.12.7 cffi==1.15.1 charset-normalizer==3.1.0 +click==8.1.3 +click-didyoumean==0.3.0 +click-plugins==1.1.1 +click-repl==0.2.0 +colorama==0.4.6 coreapi==2.3.3 coreschema==0.0.4 +cron-descriptor==1.2.35 cryptography==40.0.2 dateparser==1.1.8 defusedxml==0.7.1 Django==4.2 +django-celery-beat==2.5.0 django-debug-toolbar==4.0.0 +django-redis==5.2.0 django-templated-mail==1.1.1 +django-timezone-field==5.0 djangorestframework==3.14.0 djangorestframework-simplejwt==4.8.0 djoser==2.1.0 +gevent==22.10.2 +greenlet==2.0.2 idna==3.4 itypes==1.2.0 Jinja2==3.1.2 +kombu==5.2.4 MarkupSafe==2.1.2 +mysqlclient==2.1.1 numpy==1.24.2 oauthlib==3.2.2 +prompt-toolkit==3.0.38 pycparser==2.21 PyJWT==2.6.0 +python-crontab==2.7.1 python-dateutil==2.8.2 python-kucoin==0.1.12 python3-openid==3.2.0 pytz==2023.3 pytz-deprecation-shim==0.1.0.post0 +redis==3.5.3 regex==2023.3.23 requests==2.28.2 requests-oauthlib==1.3.1 @@ -37,4 +57,8 @@ tzdata==2023.3 tzlocal==4.3 uritemplate==4.1.1 urllib3==1.26.15 +vine==5.0.0 +wcwidth==0.2.6 websockets==11.0.1 +zope.event==4.6 +zope.interface==6.0 From 1322c53175fd776aede6baf56ed3d7452eecc465 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 15:31:01 -0700 Subject: [PATCH 10/16] add encryption functionality by django_cryptography.fields(appled on kucoing api key, secrect key, passphrase) --- ...0004_alter_user_kucoin_api_key_and_more.py | 29 +++++++++++++ project/core/models.py | 8 ++-- project/core/serializers.py | 3 +- project/requirments.txt | 41 ------------------- requirments.txt | 2 + 5 files changed, 36 insertions(+), 47 deletions(-) create mode 100644 project/core/migrations/0004_alter_user_kucoin_api_key_and_more.py delete mode 100644 project/requirments.txt diff --git a/project/core/migrations/0004_alter_user_kucoin_api_key_and_more.py b/project/core/migrations/0004_alter_user_kucoin_api_key_and_more.py new file mode 100644 index 0000000..7f6833b --- /dev/null +++ b/project/core/migrations/0004_alter_user_kucoin_api_key_and_more.py @@ -0,0 +1,29 @@ +# Generated by Django 4.2 on 2023-04-18 21:30 + +from django.db import migrations, models +import django_cryptography.fields + + +class Migration(migrations.Migration): + + dependencies = [ + ('core', '0003_user_kucoin_passphrase'), + ] + + operations = [ + migrations.AlterField( + model_name='user', + name='kucoin_api_key', + field=django_cryptography.fields.encrypt(models.CharField(blank=True, max_length=255, null=True)), + ), + migrations.AlterField( + model_name='user', + name='kucoin_api_secret', + field=django_cryptography.fields.encrypt(models.CharField(blank=True, max_length=255, null=True)), + ), + migrations.AlterField( + model_name='user', + name='kucoin_passphrase', + field=django_cryptography.fields.encrypt(models.CharField(blank=True, max_length=255, null=True)), + ), + ] diff --git a/project/core/models.py b/project/core/models.py index 661362a..9e61a5d 100644 --- a/project/core/models.py +++ b/project/core/models.py @@ -1,11 +1,11 @@ from django.db import models from django.contrib.auth.models import AbstractUser from django.utils.translation import gettext as _ - +from django_cryptography.fields import encrypt # provide name, username & kucoin details class User(AbstractUser): - kucoin_api_key = models.CharField(max_length=255, null=True, blank=True) - kucoin_api_secret = models.CharField(max_length=255, null=True, blank=True) - kucoin_passphrase = models.CharField(max_length=255, blank=True, null=True) + kucoin_api_key = encrypt(models.CharField(max_length=255, null=True, blank=True)) + kucoin_api_secret = encrypt(models.CharField(max_length=255, null=True, blank=True)) + kucoin_passphrase = encrypt(models.CharField(max_length=255, blank=True, null=True)) email = models.EmailField(_('email address'), unique=True) diff --git a/project/core/serializers.py b/project/core/serializers.py index 0fb72df..cff50b3 100644 --- a/project/core/serializers.py +++ b/project/core/serializers.py @@ -10,5 +10,4 @@ class Meta(BaseUserCreateSerializer.Meta): class UserSerializer(BaseUserSerializer): class Meta(BaseUserSerializer.Meta): - fields = ['id', 'first_name', 'last_name', 'username','email', - 'kucoin_api_key', 'kucoin_api_secret', 'kucoin_passphrase'] + fields = ['id', 'first_name', 'last_name', 'username','email'] diff --git a/project/requirments.txt b/project/requirments.txt deleted file mode 100644 index b791b4b..0000000 --- a/project/requirments.txt +++ /dev/null @@ -1,41 +0,0 @@ -asgiref==3.6.0 -certifi==2022.12.7 -cffi==1.15.1 -charset-normalizer==3.1.0 -coreapi==2.3.3 -coreschema==0.0.4 -cryptography==40.0.2 -dateparser==1.1.8 -defusedxml==0.7.1 -Django==4.2 -django-debug-toolbar==4.0.0 -django-templated-mail==1.1.1 -djangorestframework==3.14.0 -djangorestframework-simplejwt==4.8.0 -djoser==2.1.0 -idna==3.4 -itypes==1.2.0 -Jinja2==3.1.2 -MarkupSafe==2.1.2 -mysqlclient==2.1.1 -numpy==1.24.2 -oauthlib==3.2.2 -pycparser==2.21 -PyJWT==2.6.0 -python-dateutil==2.8.2 -python-kucoin==0.1.12 -python3-openid==3.2.0 -pytz==2023.3 -pytz-deprecation-shim==0.1.0.post0 -regex==2023.3.23 -requests==2.28.2 -requests-oauthlib==1.3.1 -six==1.16.0 -social-auth-app-django==4.0.0 -social-auth-core==4.4.1 -sqlparse==0.4.3 -tzdata==2023.3 -tzlocal==4.3 -uritemplate==4.1.1 -urllib3==1.26.15 -websockets==11.0.1 diff --git a/requirments.txt b/requirments.txt index c96f85e..f514569 100644 --- a/requirments.txt +++ b/requirments.txt @@ -18,7 +18,9 @@ cryptography==40.0.2 dateparser==1.1.8 defusedxml==0.7.1 Django==4.2 +django-appconf==1.0.5 django-celery-beat==2.5.0 +django-cryptography==1.1 django-debug-toolbar==4.0.0 django-redis==5.2.0 django-templated-mail==1.1.1 From d8c5af28e3286aff78248aae688e68973e9c1111 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Tue, 18 Apr 2023 17:03:08 -0700 Subject: [PATCH 11/16] add PositionsListView --- project/core/models.py | 1 + project/core/serializers.py | 2 +- project/position/pagination.py | 9 +++++++ project/position/tasks.py | 14 +++++----- project/position/urls.py | 10 ++++--- project/position/views.py | 48 ++++++++++++++++++++++++---------- project/project/settings.py | 8 ++++-- 7 files changed, 64 insertions(+), 28 deletions(-) create mode 100644 project/position/pagination.py diff --git a/project/core/models.py b/project/core/models.py index 9e61a5d..8b13f76 100644 --- a/project/core/models.py +++ b/project/core/models.py @@ -3,6 +3,7 @@ from django.utils.translation import gettext as _ from django_cryptography.fields import encrypt + # provide name, username & kucoin details class User(AbstractUser): kucoin_api_key = encrypt(models.CharField(max_length=255, null=True, blank=True)) diff --git a/project/core/serializers.py b/project/core/serializers.py index cff50b3..8dbf763 100644 --- a/project/core/serializers.py +++ b/project/core/serializers.py @@ -10,4 +10,4 @@ class Meta(BaseUserCreateSerializer.Meta): class UserSerializer(BaseUserSerializer): class Meta(BaseUserSerializer.Meta): - fields = ['id', 'first_name', 'last_name', 'username','email'] + fields = ['id', 'first_name', 'last_name', 'username', 'email'] diff --git a/project/position/pagination.py b/project/position/pagination.py new file mode 100644 index 0000000..456fa59 --- /dev/null +++ b/project/position/pagination.py @@ -0,0 +1,9 @@ +from rest_framework import pagination + + +class CustomPagination(pagination.LimitOffsetPagination): + default_limit = 10 + limit_query_param = 'l' + offset_query_param = 'o' + max_limit = 50 + order_by = 'created_at' diff --git a/project/position/tasks.py b/project/position/tasks.py index c30888a..10b8226 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -10,9 +10,10 @@ from .serializers import TrackingPositionSerializer from celery import shared_task from datetime import timedelta - +from django.conf import settings from django_redis import get_redis_connection + @dataclass class Utility: camel_pat = re.compile(r'([A-Z])') @@ -40,8 +41,9 @@ def __post_init__(self): def _set_cache(self) -> None: if self.output: _user_id = self.context.get("user_id") - self.redis_conn.set(f'cache_key_{_user_id}', json.dumps(self.output)) - self.redis_conn.expire(f'cache_key_{_user_id}', timedelta(seconds=25)) + + self.redis_conn.set(f'cache_key_{self.symbol_name}_{_user_id}', json.dumps(self.output)) + self.redis_conn.expire(f'cache_key_{_user_id}', timedelta(seconds=settings.INTERVAL - 5)) def serializing_output(self): if self.output is not None: @@ -62,16 +64,11 @@ def _internal_value(self, data: dict) -> dict: def get_positions(self) -> dict | None: # For position details url = f'https://api-futures.kucoin.com/api/v1/position?symbol={self.symbol_name}' - # For positions (list of positions) - # url = f'https://api-futures.kucoin.com/api/v1/positions' now = int(time.time() * 1000) # For position details str_to_sign = str(now) + 'GET' + f'/api/v1/position?symbol={self.symbol_name}' - # For positions (list of positions) - # str_to_sign = str(now) + 'GET' + f'/api/v1/positions' - signature = base64.b64encode( hmac.new(self.api_secret.encode('utf-8'), str_to_sign.encode('utf-8'), hashlib.sha256).digest()) passphrase = base64.b64encode( @@ -93,6 +90,7 @@ def get_positions(self) -> dict | None: print(res) return None + @shared_task def tracking_task(user, context): redis_conn = get_redis_connection("default") diff --git a/project/position/urls.py b/project/position/urls.py index 3f18766..9c35da8 100644 --- a/project/position/urls.py +++ b/project/position/urls.py @@ -1,8 +1,12 @@ -from django.urls import path +from django.urls import path, include from . import views +from rest_framework import routers + +router = routers.DefaultRouter() +router.register('positions', views.PositionsListView, basename='positions') urlpatterns = [ path('position_tracking/', views.PositionTrackingView.as_view(), name='position_tracking'), - path('position/', views.OpenPositionsView.as_view(), name='open_positions'), - + path('position//', views.LastOpenPositionsView.as_view(), name='open_positions'), + path('', include(router.urls)), ] diff --git a/project/position/views.py b/project/position/views.py index 13a64fb..8c59dec 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -1,14 +1,15 @@ from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response from rest_framework.views import APIView +from rest_framework.viewsets import GenericViewSet from .models import Position from .serializers import PositionSerializer, TrackingPositionSerializer from django_celery_beat.models import PeriodicTask, IntervalSchedule -from rest_framework import status -from datetime import datetime, timedelta -import json - +from rest_framework import status, mixins +from django.conf import settings from django_redis import get_redis_connection +from .pagination import CustomPagination +import json class PositionTrackingView(APIView): @@ -21,18 +22,17 @@ def post(self, request, symbol_name='XBTUSDM'): 'kucoin_api_secret': user.kucoin_api_secret, 'kucoin_passphrase': user.kucoin_passphrase} - my_app_name = 'position' schedule, created = IntervalSchedule.objects.get_or_create( - every=30, + every=settings.INTERVAL, period=IntervalSchedule.SECONDS, ) try: PeriodicTask.objects.create( interval=schedule, # we created this above. name=f'{user.id}_{symbol_name}', # simply describes this periodic task. (unique) - task=f'{my_app_name}.tasks.tracking_task', # name of task. + task=f'{settings.TARGET_SCHEDULE_APP_NAME}.tasks.tracking_task', # name of task. kwargs=json.dumps(dict(user=user_kucoin_secret_items, context={'user_id': user.pk})), - expires=datetime.utcnow() + timedelta(days=100) # expire time + expires=settings.EXPIRE_TIME # expire time ) except Exception as err: return Response({"message": f"Maybe you already set up tracking for symbol = {symbol_name}"}, @@ -41,14 +41,14 @@ def post(self, request, symbol_name='XBTUSDM'): return Response({'message': f'Position tracking started symbol {symbol_name}'}, status=status.HTTP_201_CREATED) -class OpenPositionsView(APIView): +class LastOpenPositionsView(APIView): permission_classes = [IsAuthenticated] serializer_class = PositionSerializer - def get(self, request): + def get(self, request, symbol_name='XBTUSDM'): user = request.user # Check if the data is already cached - cached_data = self.get_results_from_redis(user=user) + cached_data = self.get_results_from_redis(user=user, symbol=symbol_name) if cached_data: serializer = self.serializer_class(data=json.loads(cached_data)) if serializer.is_valid(): @@ -57,16 +57,36 @@ def get(self, request): return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) # Fetch data from database. - positions = Position.objects.filter(user=user).order_by('created_at') + positions = Position.objects.filter(user=user).filter(symbol=symbol_name).order_by('created_at').last() serializer = self.serializer_class(positions, many=True) return Response(serializer.data) - def get_results_from_redis(self, user): + def get_results_from_redis(self, user, symbol): result = None try: self.redis_conn = get_redis_connection("default") - result = self.redis_conn.get(f'cache_key_{user.id}') + result = self.redis_conn.get(f'cache_key_{symbol}_{user.id}') except Exception as e: # Logger exception pass return result + + +class PositionsListView(mixins.ListModelMixin, + GenericViewSet): + permission_classes = [IsAuthenticated] + serializer_class = PositionSerializer + pagination_class = CustomPagination + + def get(self, request, **kwargs): + user = request.user + positions = Position.objects.filter(user=user).order_by('created_at').all() + serializer = self.serializer_class(positions, many=True) + return Response(serializer.data) + + def get_queryset(self): + target_symbol = self.kwargs.get('symbol') + queryset = Position.objects.filter(user=self.request.user).order_by('created_at').all() + if target_symbol: + queryset = queryset.filter(symbol=target_symbol) + return queryset diff --git a/project/project/settings.py b/project/project/settings.py index ba6ecd0..df3099c 100644 --- a/project/project/settings.py +++ b/project/project/settings.py @@ -152,7 +152,7 @@ 'AUTH_HEADER_TYPES': ('JWT',), } - +#### AUTH ##################################### DJOSER = { 'SERIALIZERS': { 'user_create': 'core.serializers.UserCreateSerializer', @@ -182,5 +182,9 @@ } } +##### SCHEDULER CONFIG ################################# +from datetime import datetime, timedelta -# REDIS_CACHE_URL = 'redis://127.0.0.1:6379/1' \ No newline at end of file +EXPIRE_TIME = datetime.utcnow() + timedelta(days=100) +TARGET_SCHEDULE_APP_NAME = 'position' +INTERVAL = 30 From 8317adfa9484ea473e340c589560192b7d47f5ad Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Wed, 19 Apr 2023 01:08:47 -0700 Subject: [PATCH 12/16] add rest_framework_swagger (you can see on /docs/) --- project/position/templates/docs.html | 24 ++++++++++++++++++++++++ project/project/settings.py | 2 +- project/project/urls.py | 19 +++++++++++++++++++ 3 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 project/position/templates/docs.html diff --git a/project/position/templates/docs.html b/project/position/templates/docs.html new file mode 100644 index 0000000..521105a --- /dev/null +++ b/project/position/templates/docs.html @@ -0,0 +1,24 @@ + + + + School Service Documentation + + + + + +
+ + + + \ No newline at end of file diff --git a/project/project/settings.py b/project/project/settings.py index df3099c..344f2fe 100644 --- a/project/project/settings.py +++ b/project/project/settings.py @@ -46,7 +46,7 @@ 'core', 'position', 'django_celery_beat', - + 'rest_framework_swagger', ] MIDDLEWARE = [ diff --git a/project/project/urls.py b/project/project/urls.py index 33b5cb1..7db4f06 100644 --- a/project/project/urls.py +++ b/project/project/urls.py @@ -15,8 +15,15 @@ 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) """ from django.contrib import admin + from django.urls import path, include +from rest_framework_swagger.views import get_swagger_view +from rest_framework.schemas import get_schema_view +from django.views.generic import TemplateView + +schema_view = get_swagger_view(title='My API') + urlpatterns = [ path('admin/', admin.site.urls), @@ -28,4 +35,16 @@ path('auth/', include('djoser.urls.jwt')), path('__debug__/', include('debug_toolbar.urls')), + ### + # path('swagger/', schema_view), + + path('docs/', TemplateView.as_view( + template_name='docs.html', + extra_context={'schema_url': 'api_schema'} + ), name='swagger-ui'), + + path('api_schema/', get_schema_view( + title='API Schema', + description='Guide for the REST API' + ), name='api_schema'), ] From ebbf3e5b4ff8f24e34017535f87b943b12972f3b Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Wed, 19 Apr 2023 01:10:00 -0700 Subject: [PATCH 13/16] update requirments.txt --- requirments.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/requirments.txt b/requirments.txt index f514569..902d075 100644 --- a/requirments.txt +++ b/requirments.txt @@ -23,6 +23,7 @@ django-celery-beat==2.5.0 django-cryptography==1.1 django-debug-toolbar==4.0.0 django-redis==5.2.0 +django-rest-swagger==2.2.0 django-templated-mail==1.1.1 django-timezone-field==5.0 djangorestframework==3.14.0 @@ -31,6 +32,7 @@ djoser==2.1.0 gevent==22.10.2 greenlet==2.0.2 idna==3.4 +inflection==0.5.1 itypes==1.2.0 Jinja2==3.1.2 kombu==5.2.4 @@ -38,6 +40,8 @@ MarkupSafe==2.1.2 mysqlclient==2.1.1 numpy==1.24.2 oauthlib==3.2.2 +openapi-codec==1.3.2 +packaging==23.1 prompt-toolkit==3.0.38 pycparser==2.21 PyJWT==2.6.0 @@ -47,10 +51,13 @@ python-kucoin==0.1.12 python3-openid==3.2.0 pytz==2023.3 pytz-deprecation-shim==0.1.0.post0 +PyYAML==6.0 redis==3.5.3 regex==2023.3.23 requests==2.28.2 requests-oauthlib==1.3.1 +ruamel.yaml==0.17.21 +simplejson==3.19.1 six==1.16.0 social-auth-app-django==4.0.0 social-auth-core==4.4.1 From cf20f40949f527fc3c33bf1f591f0e05a1d0cb45 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Wed, 19 Apr 2023 02:15:05 -0700 Subject: [PATCH 14/16] add descriptions to all views and serializers --- project/core/models.py | 4 ++++ project/core/serializers.py | 9 ++++++++- project/position/models.py | 4 ++++ project/position/serializers.py | 17 +++++++++-------- project/position/tasks.py | 34 +++++++++++++-------------------- project/position/urls.py | 2 +- project/position/views.py | 19 ++++++++++++++++-- project/project/urls.py | 4 ++-- 8 files changed, 58 insertions(+), 35 deletions(-) diff --git a/project/core/models.py b/project/core/models.py index 8b13f76..49d858e 100644 --- a/project/core/models.py +++ b/project/core/models.py @@ -6,6 +6,10 @@ # provide name, username & kucoin details class User(AbstractUser): + """ + Custom User model + all KuCoins details have been encrypted and stored in the database. + """ kucoin_api_key = encrypt(models.CharField(max_length=255, null=True, blank=True)) kucoin_api_secret = encrypt(models.CharField(max_length=255, null=True, blank=True)) kucoin_passphrase = encrypt(models.CharField(max_length=255, blank=True, null=True)) diff --git a/project/core/serializers.py b/project/core/serializers.py index 8dbf763..cca24f6 100644 --- a/project/core/serializers.py +++ b/project/core/serializers.py @@ -1,13 +1,20 @@ from djoser.serializers import UserCreateSerializer as BaseUserCreateSerializer, UserSerializer as BaseUserSerializer -from rest_framework import serializers + class UserCreateSerializer(BaseUserCreateSerializer): + """ + Custom serializer inorder to create a new user based on the custom User data model. + """ class Meta(BaseUserCreateSerializer.Meta): fields = ['id', 'first_name', 'last_name', 'email', 'password', 'username', 'kucoin_api_key', 'kucoin_api_secret', 'kucoin_passphrase'] class UserSerializer(BaseUserSerializer): + """ + Custom serializer for representing users infor + (KuCoin details have been excluded) + """ class Meta(BaseUserSerializer.Meta): fields = ['id', 'first_name', 'last_name', 'username', 'email'] diff --git a/project/position/models.py b/project/position/models.py index 78d3d69..222524b 100644 --- a/project/position/models.py +++ b/project/position/models.py @@ -3,6 +3,10 @@ class Position(models.Model): + """ + This model is created based partial received data from following api + https://api-futures.kucoin.com/api/v1/position?symbol={symbol_name} + """ user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE) symbol = models.CharField(max_length=10, default='XBTUSDM') created_at = models.DateTimeField(auto_now_add=True) diff --git a/project/position/serializers.py b/project/position/serializers.py index 902fc44..289a6e9 100644 --- a/project/position/serializers.py +++ b/project/position/serializers.py @@ -4,19 +4,20 @@ class PositionSerializer(serializers.ModelSerializer): - # user_id = serializers.IntegerField() - # - # class Meta: - # model = Position - # fields = '__all__' - # # exclude = ('user',) - # read_only_fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'rist_limit') + """ + This serializer has been customized based partial received data from following api + https://api-futures.kucoin.com/api/v1/position?symbol={symbol_name} + """ class Meta: model = Position fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'risk_limit') -class TrackingPositionSerializer(serializers.ModelSerializer): +class TrackingPositionSerializer(serializers.ModelSerializer): + """ + this serializer is used to filter some additional information in all positions. + It has been applied in serializing_output method in Utility class.( it is located in tasks.py) + """ class Meta: model = Position fields = ('symbol', 'created_at', 'mark_price', 'mark_value', 'risk_limit') diff --git a/project/position/tasks.py b/project/position/tasks.py index 10b8226..6cbc201 100644 --- a/project/position/tasks.py +++ b/project/position/tasks.py @@ -16,18 +16,22 @@ @dataclass class Utility: + """ + This class implements some functionalities that can be used in + tracking task in tracking_task function and caching + """ camel_pat = re.compile(r'([A-Z])') - under_pat = re.compile(r'_([a-z])') serializer = TrackingPositionSerializer + domain = 'https://api-futures.kucoin.com' redis_conn: object - symbol_name: str = 'XBTUSDM' # or 'XBTUSDT' + symbol_name: str = 'XBTUSDM' context: dict = None api_key: str = None api_secret: str = None api_passphrase: str = None user: dict = None - output: dict = None + output: dict = None # data is fetched from KuCoins data: dict = None def __post_init__(self): @@ -42,6 +46,7 @@ def _set_cache(self) -> None: if self.output: _user_id = self.context.get("user_id") + # the structure of cache key is `cache_key_{symbol_name}_{user_id}` self.redis_conn.set(f'cache_key_{self.symbol_name}_{_user_id}', json.dumps(self.output)) self.redis_conn.expire(f'cache_key_{_user_id}', timedelta(seconds=settings.INTERVAL - 5)) @@ -50,7 +55,7 @@ def serializing_output(self): s = self.serializer(data=self.output, context=self.context) s.is_valid(raise_exception=True) s.save() - + # Set cache self._set_cache() return s.data return None @@ -63,7 +68,7 @@ def _internal_value(self, data: dict) -> dict: def get_positions(self) -> dict | None: # For position details - url = f'https://api-futures.kucoin.com/api/v1/position?symbol={self.symbol_name}' + url = f'{self.domain}/api/v1/position?symbol={self.symbol_name}' now = int(time.time() * 1000) # For position details @@ -80,14 +85,12 @@ def get_positions(self) -> dict | None: "KC-API-PASSPHRASE": passphrase, "KC-API-KEY-VERSION": "2" } - response = requests.request('get', url, headers=headers) - - res = response.json() - data = res.get('data') + response = requests.request('get', url, headers=headers).json() + data = response.get('data') if data: return self._internal_value(data=data) else: - print(res) + print(response) return None @@ -97,14 +100,3 @@ def tracking_task(user, context): print("Tracking task---------> START") Utility(user=user, context=context, redis_conn=redis_conn) print("Tracking task---------> Done") - -# if __name__ == '__main__': -# output = Utility(api_key="643ac410317fa70001647b44", -# api_secret="ffe1e63c-1467-405b-99d4-6c59b491755c", -# api_passphrase="9219474").output -# output = Utility(api_key="643e5c90d3b4b7000149c88c", -# api_secret="2e03da19-254e-4556-8055-553c62b4d44c", -# api_passphrase="9219474").output -# pprint.pprint(output) -# -# # print({camel_to_underscore(k): v for k, v in data.items()}) diff --git a/project/position/urls.py b/project/position/urls.py index 9c35da8..9ba0845 100644 --- a/project/position/urls.py +++ b/project/position/urls.py @@ -6,7 +6,7 @@ router.register('positions', views.PositionsListView, basename='positions') urlpatterns = [ - path('position_tracking/', views.PositionTrackingView.as_view(), name='position_tracking'), + path('position_tracking//', views.PositionTrackingView.as_view(), name='position_tracking'), path('position//', views.LastOpenPositionsView.as_view(), name='open_positions'), path('', include(router.urls)), ] diff --git a/project/position/views.py b/project/position/views.py index 8c59dec..08844c1 100644 --- a/project/position/views.py +++ b/project/position/views.py @@ -13,10 +13,15 @@ class PositionTrackingView(APIView): + """ + This view is used to track a symbol position in specific interval.[you must be authenticated] + these fields must be set in settings.py + EXPIRE_TIME, INTERVAL + """ permission_classes = [IsAuthenticated] def post(self, request, symbol_name='XBTUSDM'): - # code to start position tracking for the authenticated user + # Start position tracking for the authenticated user user = request.user user_kucoin_secret_items = {'kucoin_api_key': user.kucoin_api_key, 'kucoin_api_secret': user.kucoin_api_secret, @@ -42,6 +47,10 @@ def post(self, request, symbol_name='XBTUSDM'): class LastOpenPositionsView(APIView): + """ + this endpoint will return a just last tracked position based on the given symbol_name. + [you must be authenticated] + """ permission_classes = [IsAuthenticated] serializer_class = PositionSerializer @@ -74,6 +83,12 @@ def get_results_from_redis(self, user, symbol): class PositionsListView(mixins.ListModelMixin, GenericViewSet): + """ + This endpoint is used to list positions for a given symbol name otherwise + will return an all symbols list related to current user.[you must be authenticated] + query parameters: symbol_name (string) [this parameter is optional] + + """ permission_classes = [IsAuthenticated] serializer_class = PositionSerializer pagination_class = CustomPagination @@ -85,7 +100,7 @@ def get(self, request, **kwargs): return Response(serializer.data) def get_queryset(self): - target_symbol = self.kwargs.get('symbol') + target_symbol = self.kwargs.get('symbol_name') queryset = Position.objects.filter(user=self.request.user).order_by('created_at').all() if target_symbol: queryset = queryset.filter(symbol=target_symbol) diff --git a/project/project/urls.py b/project/project/urls.py index 7db4f06..8993d03 100644 --- a/project/project/urls.py +++ b/project/project/urls.py @@ -34,10 +34,10 @@ path('auth/', include('djoser.urls')), path('auth/', include('djoser.urls.jwt')), + # Debug Tools endpoints (just for development) (it can be removed with peace of mind) path('__debug__/', include('debug_toolbar.urls')), - ### - # path('swagger/', schema_view), + # swagger endpoints path('docs/', TemplateView.as_view( template_name='docs.html', extra_context={'schema_url': 'api_schema'} From b01a29d7aacf5540b6f97a82494236e150b77435 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Wed, 19 Apr 2023 02:57:22 -0700 Subject: [PATCH 15/16] update README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index c16311f..05907cf 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,39 @@ We want a clean, readable and maintainable code with meaningful comments and doc 3. Push your code to your repository 4. Send us a pull request, we will review and get back to you 5. Enjoy + +#---------------------------------------------------------------- +# All functions which have been performed in the system +- User is able to sign up , sign in, request to track position(per symbol) +- Authentication has been implemented (JWT token) +- User is able to see list of positions (cache system is applied) +- KuCoin api key & secrets are stored in encrypted format +- The system can handle multiuser requests for tracking +- Swagger has been provided in `/docs` endpoint +- pagination is provided in `/positions` endpoint +- All endpoints must be set **access token** in head as **Authorization** with prefix JWT except for `auth/user` +## All dependencies +- Redis has been applied as message broker and cache system +- Celery has been applied as task queue +- MySQL or Sqlite has been applied as database +## Installation +- activate virtualenv +- install all python requirments by `pip install -r requirements.txt` +- migrate database through `python manage.py migrate` +- **check the following fields** in settings.py +1) `CELERY_BROKER_URL` +2) `CELERY_RESULT_BACKEND` +3) `CELERY_TASK_SERIALIZER` +4) `CELERY_RESULT_SERIALIZER` +5) `CELERY_ACCEPT_CONTENT` +6) `CELERY_BEAT_SCHEDULER ,CACHES ,EXPIRE_TIME` +7) `TARGET_SCHEDULE_APP_NAME, INTERVAL` + +- Change the database backend in setting.py +- Ensure that the database and redis are installed and available. +- Run these commands in separate shells in the same python virtualenv. +1) `celery -A position beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler` +2) `celery -A position worker -l info -P gevent` +3) in development mode (`python manage.py runserver`), but you are able to use gunicorne or uwsgi +## Admin Panel +- If you register as superuser can access the `PERIODIC TASK`, it allows you to enable or disable every task whatever you want. From 7935900ae43f1a9bab88d5e854b0e86cd21e2173 Mon Sep 17 00:00:00 2001 From: Mohammad Khodadadi Date: Wed, 19 Apr 2023 02:58:29 -0700 Subject: [PATCH 16/16] modify README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 05907cf..2b54ce1 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ We want a clean, readable and maintainable code with meaningful comments and doc ## All dependencies - Redis has been applied as message broker and cache system - Celery has been applied as task queue -- MySQL or Sqlite has been applied as database +- MySQL or Sqlite has been applied as database (default database is `MySQL`) ## Installation - activate virtualenv - install all python requirments by `pip install -r requirements.txt`