{ "info": { "author": "MS List", "author_email": "simlist@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Internet :: WWW/HTTP" ], "description": "djangorestframework_emailuser\n=============================\n\n.. image:: https://travis-ci.org/simlist/django-rest-framework-emailuser.svg?branch=master\n :target: https://travis-ci.org/simlist/django-rest-framework-emailuser\n\n.. image:: https://coveralls.io/repos/github/simlist/django-rest-framework-emailuser/badge.svg?branch=master\n :target: https://coveralls.io/github/simlist/django-rest-framework-emailuser?branch=master\n\nOverview\n--------\n\nA user for djangorestframework that uses an email as the username.\n\nFeatures\n--------\n\n* Use email as username for loging in\n* One name field instead of first name and last name\n* Endpoints for creating an account, viewing, and updating accounts\n* Django admin to work with EmailUser model.\n\nRequirements\n------------\n\n- Python 3.5+\n- Django 2.2+\n- Djangorestframework 3.10+\n\nInstallation and Configuration\n------------------------------\n\nInstall using ``pip``:\n\n.. code-block:: sh\n\n $ pip install djangorestframework_emailuser\n\nAdd ``'emailuser'`` to ``INSTALLED_APPS``:\n\n.. code-block:: Python\n\n # mysite/settings.py\n INSTALLED_APPS = [\n ...\n 'emailuser',\n ]\n\nAdd the following line to ``settings.py`` to override django's default User\nmodel with the 'EmailUser' model:\n\n.. code-block:: Python\n\n # mysite/settings.py\n AUTH_USER_MODEL = 'emailuser.EmailUser'\n\nAdd urls to url conf:\n\n.. code-block:: Python\n\n # mysite/urls.py\n from django.urls import path, include\n urlpatterns = [\n ...\n path('accounts/', include('emailuser.urls')),\n ]\n\nUsing\n-----\nTo create a user programatically:\n\n.. code-block:: Python\n\n from django.contrib.auth import get_user_model\n\n normal_user = get_user_model().objects.create_user(\n email='me@example.com',\n name='My Name',\n password='MyPassword'\n )\n\n superuser = get_user_model().objects.create_superuser(\n email='admin@example.com',\n name='Super Name',\n password='MySuperPassword'\n )\n\nUsing Endpoints:\n~~~~~~~~~~~~~~~~\nAssuming emailuser urls were set to ``/accounts/``:\n\nCreating user\n?????????????\n``POST`` ``{\"email\": email, \"name\": name, \"password\": password}``\nto ``/accounts/users/register``\n\nUpdating User\n?????????????\n``PUT`` ``{\"email\": email, \"name\": name, \"password\": password}``\nto ``/accounts/users//``\nor\n``PATCH`` the attribute you want to change\nto ``/accounts/users//``\n\nReferencing User\n????????????????\nTo reference user object in your code as a string (As for foreign keys):\n\n.. code-block:: Python\n\n from django.conf import settings\n\n user_model = settings.AUTH_USER_MODEL\n\nTo reference the user class directly:\n\n.. code-block:: Python\n\n from django.contrib.auth import get_user_model\n\n user_model = get_user_model()\n\nSee `Django docs `_ for more details.\n\nAttributes\n~~~~~~~~~~\nThe EmailUser model has the following attributes:\n\nemail\n The email address used as the login username.\n\nname\n A single field for the name of the user.\npassword\n The password is hashed as set by the django settings.\n\nis_superuser\n A boolean attribute that can only be set programatically.\n\nis_staff\n A boolean attribute that can be set by the admin site or\n programatically.\n\nEmailUser also subclasses ``django.contrib.auth.models.PermissionsMixin``.\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/simlist/django-rest-framework-emailuser", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "djangorestframework-emailuser", "package_url": "https://pypi.org/project/djangorestframework-emailuser/", "platform": "", "project_url": "https://pypi.org/project/djangorestframework-emailuser/", "project_urls": { "Homepage": "https://github.com/simlist/django-rest-framework-emailuser" }, "release_url": "https://pypi.org/project/djangorestframework-emailuser/0.1.1.dev1/", "requires_dist": null, "requires_python": ">=3.5", "summary": "A user for djangorestframework that uses an email as the username.", "version": "0.1.1.dev1" }, "last_serial": 5728133, "releases": { "0.1.0.dev0": [ { "comment_text": "", "digests": { "md5": "f105a0a5b4a7ac7bf70d87c8a5b42f32", "sha256": "113a50b3baabeaafb75b3cde23daec788c8d0f4146038c441ff64ea8fa1306a0" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.0.dev0-py3-none-any.whl", "has_sig": false, "md5_digest": "f105a0a5b4a7ac7bf70d87c8a5b42f32", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7338, "upload_time": "2019-08-16T13:24:44", "url": "https://files.pythonhosted.org/packages/f2/a3/bffdf1db7c3ab0881b971807c168423f8677fadb4d7720867f5aafc03ee0/djangorestframework_emailuser-0.1.0.dev0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2a5db238d68b98e2df73eea43d1b340e", "sha256": "c539854140ec5bb4f0184850ed9c5b7f51deb4fdc3189151a200173707e273cb" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.0.dev0.tar.gz", "has_sig": false, "md5_digest": "2a5db238d68b98e2df73eea43d1b340e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5162, "upload_time": "2019-08-16T13:24:46", "url": "https://files.pythonhosted.org/packages/b1/98/5861fd00c600cdedf3736ace9989bc7f0ee05824b50824cf23b8c2ed45f9/djangorestframework_emailuser-0.1.0.dev0.tar.gz" } ], "0.1.1.dev0": [ { "comment_text": "", "digests": { "md5": "e7a28b3e4933c7ccd0c2e530d4773868", "sha256": "4c6dcf43e720821f3d30d512a213b6cf6a677335e4479f4a08e5acdadc474def" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.1.dev0-py3-none-any.whl", "has_sig": false, "md5_digest": "e7a28b3e4933c7ccd0c2e530d4773868", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7607, "upload_time": "2019-08-25T22:02:59", "url": "https://files.pythonhosted.org/packages/1a/50/7b3291c0ac50439bbc91fcf1cc3995e1377a8025640192c0f397b2b55e75/djangorestframework_emailuser-0.1.1.dev0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a4c04374b23227ddc90a7a9ad927c3c1", "sha256": "640105919d196b4366510d6be7a740ac2fbf854e1e24e194914eeeaf65ff0f97" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.1.dev0.tar.gz", "has_sig": false, "md5_digest": "a4c04374b23227ddc90a7a9ad927c3c1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5573, "upload_time": "2019-08-25T22:03:01", "url": "https://files.pythonhosted.org/packages/6b/5c/6cb0c5ce9bb37dfb0c17284fbe89e50fa8993d56b730b0af7b0edf762761/djangorestframework_emailuser-0.1.1.dev0.tar.gz" } ], "0.1.1.dev1": [ { "comment_text": "", "digests": { "md5": "2c415b71e9eee1b52fb5cfaabb069865", "sha256": "20049d8487ff37bdb351fda3a257dd16a0578e46a8f2a2ed2eb0c503be71291e" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.1.dev1-py3-none-any.whl", "has_sig": false, "md5_digest": "2c415b71e9eee1b52fb5cfaabb069865", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7607, "upload_time": "2019-08-25T22:15:03", "url": "https://files.pythonhosted.org/packages/1e/e4/03ff0a9ec59ed4412f55072b0252fb824693b83c112c79644291734414ad/djangorestframework_emailuser-0.1.1.dev1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76036fa117341df7d98abc8db2d600c0", "sha256": "bac10cee2e0e8afe4e186e699d7030ec26f5f445d1d19e34560cd9818c4d54a1" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.1.dev1.tar.gz", "has_sig": false, "md5_digest": "76036fa117341df7d98abc8db2d600c0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5586, "upload_time": "2019-08-25T22:15:06", "url": "https://files.pythonhosted.org/packages/cc/fe/f68071dc99cac91475a75362b8d49184d4576ac75d25e37222958764664e/djangorestframework_emailuser-0.1.1.dev1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2c415b71e9eee1b52fb5cfaabb069865", "sha256": "20049d8487ff37bdb351fda3a257dd16a0578e46a8f2a2ed2eb0c503be71291e" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.1.dev1-py3-none-any.whl", "has_sig": false, "md5_digest": "2c415b71e9eee1b52fb5cfaabb069865", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 7607, "upload_time": "2019-08-25T22:15:03", "url": "https://files.pythonhosted.org/packages/1e/e4/03ff0a9ec59ed4412f55072b0252fb824693b83c112c79644291734414ad/djangorestframework_emailuser-0.1.1.dev1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76036fa117341df7d98abc8db2d600c0", "sha256": "bac10cee2e0e8afe4e186e699d7030ec26f5f445d1d19e34560cd9818c4d54a1" }, "downloads": -1, "filename": "djangorestframework_emailuser-0.1.1.dev1.tar.gz", "has_sig": false, "md5_digest": "76036fa117341df7d98abc8db2d600c0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5586, "upload_time": "2019-08-25T22:15:06", "url": "https://files.pythonhosted.org/packages/cc/fe/f68071dc99cac91475a75362b8d49184d4576ac75d25e37222958764664e/djangorestframework_emailuser-0.1.1.dev1.tar.gz" } ] }