Feat/django 4 compatibility

.editorconfig

@@ -0,0 +1,23 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.{html,css,scss,json,yml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -1,3 +1,159 @@
-*.pyc
-*~
-*.tmp
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+__pycache__
+
+# C extensions
+*.so
+
+# If you are using PyCharm #
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/gradle.xml
+.idea/**/libraries
+*.iws /out/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+-# Mr Developer
+-.mr.developer.cfg
+-.project
+-.pydevproject
+
+-# Sphinx
+-docs/_build
+
+-# Complexity
+-output/*.html
+-output/*/index.html
+
+-example/db.sqlite3

LICENSE

@@ -0,0 +1,43 @@
+MIT License
+
+Copyright (c) 2018 Alexander Tereshkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+MIT License
+
+Copyright (c) 2018 Bearle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include web3auth *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

README.md

@@ -1,33 +1,78 @@
-# Django-Web3-Auth
+# django-web3-auth
 
-django-web3-auth is a pluggable Django app that enables login/signup via an Ethereum wallet (a la CryptoKitties). The user authenticates themselves by digitally signing the session key with their wallet's private key.
+django-web3-auth is a pluggable Django app that enables login/signup via an Ethereum wallet (specifically MetaMask).  
+The user authenticates themselves by digitally signing the session key with their wallet's private key.
+
+Use with django >= 3.2.0, python >= 3.9
 
-## Installation
-
-django-web3-auth has no releases yet, you'll need to install it from repository:
+## Quickstart
+Install django-web3-auth with pip:
 ```bash
-pip install https://github.com/atereshkin/django-web3-auth/archive/master.zip
+pip install git+ssh://git@github.com/krilarite/django-web3-auth.git
 ```
-
-You will also need [Web3.js](https://github.com/ethereum/web3.js) included in your pages.
-
-## Usage
-
-1. Add `'web3auth'` to the `INSTALLED_APPS` setting
-2. Set `'web3auth.backend.Web3Backend'` as your authentication backend:
+Add it to your INSTALLED_APPS:
+```python
+INSTALLED_APPS = [
+    ...
+    'web3auth',
+    ...
+]
+```
+Set 'web3auth.backend.Web3Backend' as your authentication backend:
 ```python
-AUTHENTICATION_BACKENDS = ['web3auth.backend.Web3Backend']
+AUTHENTICATION_BACKENDS = [
+    'django.contrib.auth.backends.ModelBackend',
+    'web3auth.backend.Web3Backend'
+]
 ```
-3. Bind some URLs to `web3auth.views.login_view` and `web3auth.views.signup_view`. Both views take an optional `template_name` argument. 
+Set a field from the User model for storing the users' ETH address:
 ```python
-from django.conf.urls import url
-
-from web3auth import views as web3auth_views
+WEB3AUTH_USER_ADDRESS_FIELD = 'username'
+```
+Add Django-Web3-Auth's URL patterns:
+```python
+from web3auth import urls as web3auth_urls
 
 urlpatterns = [
-    url(r'^login/$', web3auth_views.login_view, {'template_name' : 'login.html'}, name='login'),
-    url(r'^signup/$', web3auth_views.signup_view, name='signup'),
+    ...
+    path('', include(web3auth_urls)),
+    ...
 ]
+```
+Add some javascript to handle login:
+```html
+  <script src="{% static 'web3auth/js/web3.js' %}"></script>
+  <script src="{% static 'web3auth/js/web3auth.js' %}"></script>
+```
+Implement a login button:
+```html
+<button type="button" onclick="connectWallet()">Connect wallet</button>
+<script>
+async function connectWallet() {
+    var authUrl = "{% url 'web3auth:web3auth_api' %}";
+    await authWeb3(authUrl, console.log, console.log, console.log, console.log, console.log, function (resp) {
+        window.location.replace(resp.redirect_url);
+    });
+};
+</script>
+```
+MetaMask will prompt you to sign a message and you'll be logged in afterwards.
+
 
+## Contributing
+Clone the project
+```bash
+git clone [email protected]:krilarite/django-web3-auth.git
+```
+Set up a virtualenv
+```
+mkvirtualenv -p /usr/bin/python3.9 -a `pwd` django-web3-auth
+pip install -r requirements.txt
+```
+Use the example project for testing
+```bash
+cd example
+python manage.py migrate
+python manage.py runserver
 ```
-4. Code your templates for login and signup pages. Example code can be found in [login.html](web3auth/templates/web3auth/login.html) and [signup.html](web3auth/templates/web3auth/signup.html)
+Navigate to `localhost:8000/login` and you'll see a login page.

example/README.md

@@ -0,0 +1,25 @@
+Example Project for web3auth
+
+This example is provided as a convenience feature to allow potential users to try the app straight from the app repo without having to create a django project.
+
+It can also be used to develop the app in place.
+
+To run this example, follow these instructions:
+
+1. Clone the repository
+2. Navigate to the `example` directory
+3. Install the requirements for the package (probably in a virtualenv):
+
+		pip install -r requirements.txt
+
+4. Make and apply migrations
+
+		python manage.py makemigrations
+
+		python manage.py migrate
+
+5. Run the server
+
+		python manage.py runserver
+
+6. Access from the browser at `http://127.0.0.1:8000`