<h1 align="center">
django-user-email
</h1>
<p align="center">
<a href="https://github.com/khasbilegt/django-user-email/">
<img src="https://img.shields.io/github/actions/workflow/status/khasbilegt/django-user-email/ci.yml?label=CI&logo=github&style=for-the-badge" alt="ci status">
</a>
<a href="https://pypi.org/project/django-user-email/">
<img src="https://img.shields.io/pypi/v/django-user-email?style=for-the-badge" alt="pypi link">
</a>
<a href="https://codecov.io/github/khasbilegt/django-user-email">
<img src="https://img.shields.io/codecov/c/github/khasbilegt/django-user-email?logo=codecov&style=for-the-badge" alt="codecov">
</a>
<br>
<a>
<img src="https://img.shields.io/pypi/pyversions/django-user-email?logo=python&style=for-the-badge" alt="supported python versions">
</a>
<a>
<img src="https://img.shields.io/pypi/djversions/django-user-email?logo=django&style=for-the-badge" alt="supported django versions">
</a>
</p>
<p align="center">
<a href="#installation">Installation</a> •
<a href="#contributing">Contributing</a> •
<a href="#license">License</a>
</p>
<p align="center">Custom, simple Django User model with email as username</p>
## Installation
1. Use your preferred package manager ([pip](https://pip.pypa.io/en/stable/), [poetry](https://pypi.org/project/poetry/), [pipenv](https://pypi.org/project/pipenv/)) to install the package. For example:
```bash
$ poetry add django-user-email
```
2. Then register 'user_email', in the 'INSTALLED_APPS' section of your project's settings.
```python
# settings.py
...
INSTALLED_APPS = (
...
'user_email',
)
...
```
3. Set AUTH_USER_MODEL - Since it's a custom User model Django needs to know the path of the model
```bash
# settings.py
...
AUTH_USER_MODEL = 'user_email.User'
...
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT License](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/khasbilegt/django-user-email",
"name": "django-user-email",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "django, model, user, email, username, custom",
"author": "Khasbilegt.TS",
"author_email": "khasbilegt.ts@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/76/01/c0e4b6dd90462e8860849bcaa36c25adc1afd4618f8b580dddec76bb4ab3/django_user_email-1.1.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n django-user-email\n</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/khasbilegt/django-user-email/\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/khasbilegt/django-user-email/ci.yml?label=CI&logo=github&style=for-the-badge\" alt=\"ci status\">\n </a>\n <a href=\"https://pypi.org/project/django-user-email/\">\n <img src=\"https://img.shields.io/pypi/v/django-user-email?style=for-the-badge\" alt=\"pypi link\">\n </a>\n <a href=\"https://codecov.io/github/khasbilegt/django-user-email\">\n <img src=\"https://img.shields.io/codecov/c/github/khasbilegt/django-user-email?logo=codecov&style=for-the-badge\" alt=\"codecov\">\n </a>\n <br>\n <a>\n <img src=\"https://img.shields.io/pypi/pyversions/django-user-email?logo=python&style=for-the-badge\" alt=\"supported python versions\">\n </a>\n <a>\n <img src=\"https://img.shields.io/pypi/djversions/django-user-email?logo=django&style=for-the-badge\" alt=\"supported django versions\">\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"#installation\">Installation</a> \u2022\n <a href=\"#contributing\">Contributing</a> \u2022\n <a href=\"#license\">License</a>\n</p>\n\n<p align=\"center\">Custom, simple Django User model with email as username</p>\n\n## Installation\n\n1. Use your preferred package manager ([pip](https://pip.pypa.io/en/stable/), [poetry](https://pypi.org/project/poetry/), [pipenv](https://pypi.org/project/pipenv/)) to install the package. For example:\n\n```bash\n$ poetry add django-user-email\n```\n\n2. Then register 'user_email', in the 'INSTALLED_APPS' section of your project's settings.\n\n```python\n# settings.py\n...\n\nINSTALLED_APPS = (\n ...\n 'user_email',\n)\n\n...\n```\n\n3. Set AUTH_USER_MODEL - Since it's a custom User model Django needs to know the path of the model\n\n```bash\n# settings.py\n...\n\nAUTH_USER_MODEL = 'user_email.User'\n\n...\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT License](https://choosealicense.com/licenses/mit/)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Custom, simple Django User model with email as username",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/khasbilegt/django-user-email",
"Repository": "https://github.com/khasbilegt/django-user-email"
},
"split_keywords": [
"django",
" model",
" user",
" email",
" username",
" custom"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abe0e2ecb98f713e53f49cf1305bebf7578437af8237a0036c1471742d9c8946",
"md5": "0e4262075caa66c4e3d2c53cc04d110c",
"sha256": "58ca89b417e59bb7315547140b7d3c6f2c5b29097dd4c22682988c7138df0af8"
},
"downloads": -1,
"filename": "django_user_email-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e4262075caa66c4e3d2c53cc04d110c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 8226,
"upload_time": "2024-04-20T18:51:17",
"upload_time_iso_8601": "2024-04-20T18:51:17.944757Z",
"url": "https://files.pythonhosted.org/packages/ab/e0/e2ecb98f713e53f49cf1305bebf7578437af8237a0036c1471742d9c8946/django_user_email-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7601c0e4b6dd90462e8860849bcaa36c25adc1afd4618f8b580dddec76bb4ab3",
"md5": "d4ff06008072bb47256f5b00af275d77",
"sha256": "6f1a0e53d98ba4aaa8ee287ac3fbd6f63ee356d2b40d6ce4f814c8a721948865"
},
"downloads": -1,
"filename": "django_user_email-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d4ff06008072bb47256f5b00af275d77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 4887,
"upload_time": "2024-04-20T18:51:19",
"upload_time_iso_8601": "2024-04-20T18:51:19.506395Z",
"url": "https://files.pythonhosted.org/packages/76/01/c0e4b6dd90462e8860849bcaa36c25adc1afd4618f8b580dddec76bb4ab3/django_user_email-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 18:51:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "khasbilegt",
"github_project": "django-user-email",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-user-email"
}
JSON
