mirror of
https://github.com/Tivix/django-rest-auth.git
synced 2024-12-02 05:43:44 +03:00
Updates names
This commit is contained in:
Michael
parent
92cc9c18ec
commit
f7da276bd2
31
README.rst
31
README.rst
|
|
@ -1,31 +0,0 @@
|
|||
Welcome to dj-rest-auth
|
||||
===========================
|
||||
|
||||
.. image:: https://travis-ci.org/iMerica/dj-rest-auth.svg
|
||||
:target: https://travis-ci.org/iMerica/dj-rest-auth
|
||||
|
||||
|
||||
.. image:: https://coveralls.io/repos/iMerica/dj-rest-auth/badge.svg
|
||||
:target: https://coveralls.io/r/iMerica/dj-rest-auth?branch=master
|
||||
|
||||
|
||||
.. image:: https://readthedocs.org/projects/dj-rest-auth/badge/?version=latest
|
||||
:target: https://readthedocs.org/projects/dj-rest-auth/?badge=latest
|
||||
|
||||
|
||||
Django-dj-rest-auth provides a set of REST API endpoints for Authentication and Registration
|
||||
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
http://dj-rest-auth.readthedocs.org/en/latest/
|
||||
|
||||
|
||||
Source code
|
||||
-----------
|
||||
https://github.com/iMerica/dj-rest-auth
|
||||
|
||||
|
||||
Stack Overflow
|
||||
-----------
|
||||
http://stackoverflow.com/questions/tagged/dj-rest-auth
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
# Czech translations of Tivix/django-rest-auth
|
||||
# Czech translations of iMerica/dj-rest-auth
|
||||
#
|
||||
# This file is distributed under the same license as the Tivix/django-rest-auth package.
|
||||
# This file is distributed under the same license as the iMerica/dj-rest-auth package.
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Tivix/django-rest-auth\n"
|
||||
"Report-Msgid-Bugs-To: https://github.com/Tivix/django-rest-auth/issues\n"
|
||||
"Project-Id-Version: iMerica/dj-rest-auth\n"
|
||||
"Report-Msgid-Bugs-To: https://github.com/iMerica/dj-rest-auth/issues\n"
|
||||
"POT-Creation-Date: 2018-06-27 23:05+0200\n"
|
||||
"PO-Revision-Date: 2018-06-27 23:22+0200\n"
|
||||
"Language: cs\n"
|
||||
|
|
|
|||
|
|
@ -164,7 +164,7 @@ class UserDetailsView(RetrieveUpdateAPIView):
|
|||
"""
|
||||
Adding this method since it is sometimes called when using
|
||||
django-rest-swagger
|
||||
https://github.com/Tivix/django-rest-auth/issues/275
|
||||
https://github.com/iMerica/dj-rest-auth/issues/275
|
||||
"""
|
||||
return get_user_model().objects.none()
|
||||
|
||||
|
|
|
|||
|
|
@ -85,17 +85,17 @@ qthelp:
|
|||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-rest-auth.qhcp"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/dj-rest-auth.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-rest-auth.qhc"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/dj-rest-auth.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/django-rest-auth"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-rest-auth"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/dj-rest-auth"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/dj-rest-auth"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ API endpoints
|
|||
Basic
|
||||
-----
|
||||
|
||||
- /rest-auth/login/ (POST)
|
||||
- /dj-rest-auth/login/ (POST)
|
||||
|
||||
- username
|
||||
- email
|
||||
|
|
@ -12,24 +12,24 @@ Basic
|
|||
|
||||
Returns Token key
|
||||
|
||||
- /rest-auth/logout/ (POST)
|
||||
- /dj-rest-auth/logout/ (POST)
|
||||
|
||||
.. note:: ``ACCOUNT_LOGOUT_ON_GET = True`` to allow logout using GET - this is the exact same configuration from allauth. NOT recommended, see: http://django-allauth.readthedocs.io/en/latest/views.html#logout
|
||||
|
||||
- /rest-auth/password/reset/ (POST)
|
||||
- /dj-rest-auth/password/reset/ (POST)
|
||||
|
||||
- email
|
||||
|
||||
- /rest-auth/password/reset/confirm/ (POST)
|
||||
- /dj-rest-auth/password/reset/confirm/ (POST)
|
||||
|
||||
- uid
|
||||
- token
|
||||
- new_password1
|
||||
- new_password2
|
||||
|
||||
.. note:: uid and token are sent in email after calling /rest-auth/password/reset/
|
||||
.. note:: uid and token are sent in email after calling /dj-rest-auth/password/reset/
|
||||
|
||||
- /rest-auth/password/change/ (POST)
|
||||
- /dj-rest-auth/password/change/ (POST)
|
||||
|
||||
- new_password1
|
||||
- new_password2
|
||||
|
|
@ -38,7 +38,7 @@ Basic
|
|||
.. note:: ``OLD_PASSWORD_FIELD_ENABLED = True`` to use old_password.
|
||||
.. note:: ``LOGOUT_ON_PASSWORD_CHANGE = False`` to keep the user logged in after password change
|
||||
|
||||
- /rest-auth/user/ (GET, PUT, PATCH)
|
||||
- /dj-rest-auth/user/ (GET, PUT, PATCH)
|
||||
|
||||
- username
|
||||
- first_name
|
||||
|
|
@ -50,14 +50,14 @@ Basic
|
|||
Registration
|
||||
------------
|
||||
|
||||
- /rest-auth/registration/ (POST)
|
||||
- /dj-rest-auth/registration/ (POST)
|
||||
|
||||
- username
|
||||
- password1
|
||||
- password2
|
||||
- email
|
||||
|
||||
- /rest-auth/registration/verify-email/ (POST)
|
||||
- /dj-rest-auth/registration/verify-email/ (POST)
|
||||
|
||||
- key
|
||||
|
||||
|
|
@ -67,14 +67,14 @@ Social Media Authentication
|
|||
|
||||
Basing on example from installation section :doc:`Installation </installation>`
|
||||
|
||||
- /rest-auth/facebook/ (POST)
|
||||
- /dj-rest-auth/facebook/ (POST)
|
||||
|
||||
- access_token
|
||||
- code
|
||||
|
||||
.. note:: ``access_token`` OR ``code`` can be used as standalone arguments, see https://github.com/Tivix/django-rest-auth/blob/master/dj_rest_auth/registration/views.py
|
||||
.. note:: ``access_token`` OR ``code`` can be used as standalone arguments, see https://github.com/iMerica/dj-rest-auth/blob/master/dj_rest_auth/registration/views.py
|
||||
|
||||
- /rest-auth/twitter/ (POST)
|
||||
- /dj-rest-auth/twitter/ (POST)
|
||||
|
||||
- access_token
|
||||
- token_secret
|
||||
|
|
|
|||
20
docs/conf.py
20
docs/conf.py
|
|
@ -1,6 +1,6 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# django-rest-auth documentation build configuration file, created by
|
||||
# dj-rest-auth documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Oct 8 15:59:37 2014.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
|
|
@ -43,8 +43,8 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'django-rest-auth'
|
||||
copyright = u'2018, Tivix Inc.'
|
||||
project = u'dj-rest-auth'
|
||||
copyright = u'2018, iMerica Inc.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
|
|
@ -176,7 +176,7 @@ html_static_path = ['_static']
|
|||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'django-rest-authdoc'
|
||||
htmlhelp_basename = 'dj-rest-authdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
|
@ -196,8 +196,8 @@ latex_elements = {
|
|||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'django-rest-auth.tex', u'django-rest-auth Documentation',
|
||||
u'Tivix Inc.', 'manual'),
|
||||
('index', 'dj-rest-auth.tex', u'dj-rest-auth Documentation',
|
||||
u'iMerica Inc.', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
|
|
@ -226,8 +226,8 @@ latex_documents = [
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'django-rest-auth', u'django-rest-auth Documentation',
|
||||
[u'Tivix Inc.'], 1)
|
||||
('index', 'dj-rest-auth', u'dj-rest-auth Documentation',
|
||||
[u'iMerica Inc.'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
|
|
@ -240,8 +240,8 @@ man_pages = [
|
|||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'django-rest-auth', u'django-rest-auth Documentation',
|
||||
u'Tivix Inc.', 'django-rest-auth', 'One line description of project.',
|
||||
('index', 'dj-rest-auth', u'dj-rest-auth Documentation',
|
||||
u'iMerica Inc.', 'dj-rest-auth', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@ Demo project
|
|||
============
|
||||
|
||||
The idea of creating demo project was to show how you can potentially use
|
||||
django-rest-auth app with jQuery on frontend.
|
||||
dj-rest-auth app with jQuery on frontend.
|
||||
Do these steps to make it running (ideally in virtualenv).
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
cd /tmp
|
||||
git clone https://github.com/Tivix/django-rest-auth.git
|
||||
cd django-rest-auth/demo/
|
||||
git clone https://github.com/iMerica/dj-rest-auth.git
|
||||
cd dj-rest-auth/demo/
|
||||
pip install -r requirements.pip
|
||||
python manage.py migrate --settings=demo.settings --noinput
|
||||
python manage.py runserver --settings=demo.settings
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
.. django-rest-auth documentation master file, created by
|
||||
.. dj-rest-auth documentation master file, created by
|
||||
sphinx-quickstart on Wed Oct 8 15:59:37 2014.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to django-rest-auth's documentation!
|
||||
Welcome to dj-rest-auth's documentation!
|
||||
============================================
|
||||
|
||||
.. warning:: Updating django-rest-auth from version **0.3.3** is highly recommended because of a security issue in PasswordResetConfirmation validation method.
|
||||
.. warning:: Updating dj-rest-auth from version **0.3.3** is highly recommended because of a security issue in PasswordResetConfirmation validation method.
|
||||
|
||||
.. note:: django-rest-auth from v0.3.3 supports django-rest-framework v3.0
|
||||
.. note:: dj-rest-auth from v0.3.3 supports django-rest-framework v3.0
|
||||
|
||||
|
||||
|build-status| |coverage-status| |requirements-status| |docs|
|
||||
|
|
@ -28,25 +28,25 @@ Contents
|
|||
Changelog <changelog>
|
||||
|
||||
|
||||
.. |build-status| image:: https://travis-ci.org/Tivix/django-rest-auth.svg?branch=master
|
||||
.. |build-status| image:: https://travis-ci.org/iMerica/dj-rest-auth.svg?branch=master
|
||||
:alt: build status
|
||||
:scale: 100%
|
||||
:target: https://travis-ci.org/Tivix/django-rest-auth
|
||||
:target: https://travis-ci.org/iMerica/dj-rest-auth
|
||||
|
||||
|
||||
.. |coverage-status| image:: https://coveralls.io/repos/Tivix/django-rest-auth/badge.png?branch=master
|
||||
.. |coverage-status| image:: https://coveralls.io/repos/iMerica/dj-rest-auth/badge.png?branch=master
|
||||
:alt: coverage status
|
||||
:scale: 100%
|
||||
:target: https://coveralls.io/r/Tivix/django-rest-auth?branch=master
|
||||
:target: https://coveralls.io/r/iMerica/dj-rest-auth?branch=master
|
||||
|
||||
|
||||
.. |requirements-status| image:: https://requires.io/github/Tivix/django-rest-auth/requirements.png?branch=master
|
||||
.. |requirements-status| image:: https://requires.io/github/iMerica/dj-rest-auth/requirements.png?branch=master
|
||||
:alt: requirements status
|
||||
:scale: 100%
|
||||
:target: https://requires.io/github/Tivix/django-rest-auth/requirements/?branch=master
|
||||
:target: https://requires.io/github/iMerica/dj-rest-auth/requirements/?branch=master
|
||||
|
||||
|
||||
.. |docs| image:: https://readthedocs.org/projects/django-rest-auth/badge/?version=latest
|
||||
.. |docs| image:: https://readthedocs.org/projects/dj-rest-auth/badge/?version=latest
|
||||
:scale: 100%
|
||||
:target: https://readthedocs.org/projects/django-rest-auth/?badge=latest
|
||||
:target: https://readthedocs.org/projects/dj-rest-auth/?badge=latest
|
||||
:alt: Documentation Status
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Installation
|
|||
|
||||
.. code-block:: python
|
||||
|
||||
pip install django-rest-auth
|
||||
pip install dj-rest-auth
|
||||
|
||||
2. Add ``dj_rest_auth`` app to INSTALLED_APPS in your django settings.py:
|
||||
|
||||
|
|
@ -44,7 +44,7 @@ You're good to go now!
|
|||
Registration (optional)
|
||||
-----------------------
|
||||
|
||||
1. If you want to enable standard registration process you will need to install ``django-allauth`` by using ``pip install django-rest-auth[with_social]``.
|
||||
1. If you want to enable standard registration process you will need to install ``django-allauth`` by using ``pip install dj-rest-auth[with_social]``.
|
||||
|
||||
2. Add ``django.contrib.sites``, ``allauth``, ``allauth.account`` and ``dj_rest_auth.registration`` apps to INSTALLED_APPS in your django settings.py:
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ Registration (optional)
|
|||
Social Authentication (optional)
|
||||
--------------------------------
|
||||
|
||||
Using ``django-allauth``, ``django-rest-auth`` provides helpful class for creating social media authentication view.
|
||||
Using ``django-allauth``, ``dj-rest-auth`` provides helpful class for creating social media authentication view.
|
||||
|
||||
.. note:: Points 1 and 2 are related to ``django-allauth`` configuration, so if you have already configured social authentication, then please go to step 3. See ``django-allauth`` documentation for more details.
|
||||
|
||||
|
|
@ -246,7 +246,7 @@ You can also use the following views to check all social accounts attached to th
|
|||
JSON Web Token (JWT) Support (optional)
|
||||
---------------------------------------
|
||||
|
||||
By default ``django-rest-auth`` uses Django's Token-based authentication. If you want to use JWT authentication, follow these steps:
|
||||
By default ``dj-rest-auth`` uses Django's Token-based authentication. If you want to use JWT authentication, follow these steps:
|
||||
|
||||
1. Install `djangorestframework-jwt <http://getblimp.github.io/django-rest-framework-jwt/>`_
|
||||
- ``djangorestframework-jwt`` is currently the only supported JWT library.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ Introduction
|
|||
============
|
||||
|
||||
|
||||
Since the introduction of django-rest-framework, Django apps have been able to serve up app-level REST API endpoints. As a result, we saw a lot of instances where developers implemented their own REST registration API endpoints here and there, snippets, and so on. We aim to solve this demand by providing django-rest-auth, a set of REST API endpoints to handle User Registration and Authentication tasks. By having these API endpoints, your client apps such as AngularJS, iOS, Android, and others can communicate to your Django backend site independently via REST APIs for User Management. Of course, we'll add more API endpoints as we see the demand.
|
||||
Since the introduction of django-rest-framework, Django apps have been able to serve up app-level REST API endpoints. As a result, we saw a lot of instances where developers implemented their own REST registration API endpoints here and there, snippets, and so on. We aim to solve this demand by providing dj-rest-auth, a set of REST API endpoints to handle User Registration and Authentication tasks. By having these API endpoints, your client apps such as AngularJS, iOS, Android, and others can communicate to your Django backend site independently via REST APIs for User Management. Of course, we'll add more API endpoints as we see the demand.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
|
@ -25,7 +25,7 @@ Apps structure
|
|||
Angular app
|
||||
-----------
|
||||
|
||||
- Tivix has also created angular module which uses API endpoints from this app - `angular-django-registration-auth <https://github.com/Tivix/angular-django-registration-auth>`_
|
||||
- iMerica has also created angular module which uses API endpoints from this app - `angular-django-registration-auth <https://github.com/iMerica/angular-django-registration-auth>`_
|
||||
|
||||
|
||||
Demo project
|
||||
|
|
|
|||
|
|
@ -115,9 +115,9 @@ if "%1" == "qthelp" (
|
|||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-rest-auth.qhcp
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\dj-rest-auth.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-rest-auth.ghc
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\dj-rest-auth.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
|
|
|
|||
4
setup.py
4
setup.py
|
|
@ -11,11 +11,11 @@ f.close()
|
|||
|
||||
|
||||
setup(
|
||||
name='django-rest-auth',
|
||||
name='dj-rest-auth',
|
||||
version='0.9.5',
|
||||
author='Sumit Chachra',
|
||||
author_email='chachra@tivix.com',
|
||||
url='http://github.com/Tivix/django-rest-auth',
|
||||
url='http://github.com/iMerica/dj-rest-auth',
|
||||
description='Create a set of REST API endpoints for Authentication and Registration',
|
||||
packages=find_packages(),
|
||||
long_description=long_description,
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user