Rename begin

Author: delneg

AUTHORS.rst

@@ -7,7 +7,7 @@ Development Lead
 
 * Denis Bobrov <tech@bearle.ru>
 
-Contributors
+Special Thanks
 ------------
 
-* Alexander Tereshkin <atereshkin@y-node.com>
+* Nathan James <scatter.eos@gmail.com>

CONTRIBUTING.rst

@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/Bearle/django-web3-auth/issues.
+Report bugs at https://github.com/Bearle/django-scatter-auth/issues.
 
 If you are reporting a bug, please include:
 
@@ -36,14 +36,14 @@ is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-Django-Web3-Auth could always use more documentation, whether as part of the
-official Django-Web3-Auth docs, in docstrings, or even on the web in blog posts,
+Django-scatter-auth could always use more documentation, whether as part of the
+official Django-scatter-auth docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/Bearle/django-web3-auth/issues.
+The best way to send feedback is to file an issue at https://github.com/Bearle/django-scatter-auth/issues.
 
 If you are proposing a feature:
 
@@ -55,17 +55,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `django-web3-auth` for local development.
+Ready to contribute? Here's how to set up `django-scatter-auth` for local development.
 
-1. Fork the `django-web3-auth` repo on GitHub.
+1. Fork the `django-scatter-auth` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/django-web3-auth.git
+    $ git clone git@github.com:your_name_here/django-scatter-auth.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv django-web3-auth
-    $ cd django-web3-auth/
+    $ mkvirtualenv django-scatter-auth
+    $ cd django-scatter-auth/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -101,7 +101,7 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
-   https://travis-ci.org/Bearle/django-web3-auth/pull_requests
+   https://travis-ci.org/Bearle/django-scatter-auth/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips

HISTORY.rst

@@ -3,7 +3,7 @@
 History
 -------
 
-0.1.0 (2018-06-29)
+0.1.0 (2018-08-06)
 ++++++++++++++++++
 
 * First release on PyPi

MANIFEST.in

@@ -3,4 +3,4 @@ include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
 include README.rst
-recursive-include web3auth *.html *.png *.gif *js *.css *jpg *jpeg *svg *py
+recursive-include scatterauth *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

Makefile

@@ -28,7 +28,7 @@ clean-pyc: ## remove Python file artifacts
 	find . -name '*~' -exec rm -f {} +
 
 lint: ## check style with flake8
-	flake8 web3auth tests
+	flake8 scatterauth tests
 
 test: ## run tests quickly with the default Python
 	python runtests.py tests
@@ -37,15 +37,15 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source web3auth runtests.py tests
+	coverage run --source scatterauth runtests.py tests
 	coverage report -m
 	coverage html
 	open htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/django-web3-auth.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ web3auth
+	sphinx-apidoc -o docs/ scatterauth
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

README.rst

@@ -1,29 +1,29 @@
 =============================
-Django-Web3-Auth
+django-scatter-auth
 =============================
 
-.. image:: https://badge.fury.io/py/django-web3-auth.svg
-    :target: https://badge.fury.io/py/django-web3-auth
+.. image:: https://badge.fury.io/py/django-scatter-auth.svg
+    :target: https://badge.fury.io/py/django-scatter-auth
 
-.. image:: https://travis-ci.org/Bearle/django-web3-auth.svg?branch=master
-    :target: https://travis-ci.org/Bearle/django-web3-auth
+.. image:: https://travis-ci.org/Bearle/django-scatter-auth.svg?branch=master
+    :target: https://travis-ci.org/Bearle/django-scatter-auth
 
-.. image:: https://codecov.io/gh/Bearle/django-web3-auth/branch/master/graph/badge.svg
-    :target: https://codecov.io/gh/Bearle/django-web3-auth
+.. image:: https://codecov.io/gh/Bearle/django-scatter-auth/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/Bearle/django-scatter-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-scatter-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.
 
-.. image:: https://github.com/Bearle/django-web3-auth/blob/master/docs/_static/web3_auth_test.gif?raw=true
+.. image:: https://github.com/Bearle/django-scatter-auth/blob/master/docs/_static/web3_auth_test.gif?raw=true
 
 Documentation
 -------------
 
-The full documentation is at https://django-web3-auth.readthedocs.io.
+The full documentation is at https://django-scatter-auth.readthedocs.io.
 
 Example project
 ---------------
 
-https://github.com/Bearle/django-web3-auth/tree/master/example
+https://github.com/Bearle/django-scatter-auth/tree/master/example
 
 You can check out our example project by cloning the repo and heading into example/ directory.
 There is a README file for you to check, also.
@@ -43,26 +43,26 @@ Features
 
 Quickstart
 ----------
-Install Django-Web3-Auth with pip::
+Install django-scatter-auth with pip::
 
-    pip install django-web3-auth
+    pip install django-scatter-auth
 
 Add it to your `INSTALLED_APPS`:
 
 .. code-block:: python
 
     INSTALLED_APPS = (
         ...
-        'web3auth.apps.Web3AuthConfig',
+        'scatterauth.apps.scatterauthConfig',
         ...
     )
-Set `'web3auth.backend.Web3Backend'` as your authentication backend:
+Set `'scatterauth.backend.Web3Backend'` as your authentication backend:
 
 .. code-block:: python
 
     AUTHENTICATION_BACKENDS = [
     'django.contrib.auth.backends.ModelBackend',
-    'web3auth.backend.Web3Backend'
+    'scatterauth.backend.Web3Backend'
     ]
 Set your User model's field to use as ETH address provider:
 
@@ -77,16 +77,16 @@ And if you have some other fields you want to be in the SignupForm, add them too
     SCATTERAUTH_USER_SIGNUP_FIELDS = ['email',]
 
 
-Add Django-Web3-Auth's URL patterns:
+Add django-scatter-auth's URL patterns:
 
 .. code-block:: python
 
-    from web3auth import urls as web3auth_urls
+    from scatterauth import urls as scatterauth_urls
 
 
     urlpatterns = [
         ...
-        url(r'^', include(web3auth_urls)),
+        url(r'^', include(scatterauth_urls)),
         ...
     ]
 
@@ -95,7 +95,7 @@ Add some javascript to handle login:
 
 .. code-block:: html
 
-    <script src="{% static 'web3auth/js/web3auth.js' %}"></script>
+    <script src="{% static 'scatterauth/js/scatterauth.js' %}"></script>
 
 
 .. code-block:: javascript
@@ -106,7 +106,7 @@ Add some javascript to handle login:
           if (!loggedIn) {
             alert("Please unlock your web3 provider (probably, Metamask)")
           } else {
-            var login_url = '{% url 'web3auth_login_api' %}';
+            var login_url = '{% url 'scatterauth_login_api' %}';
             web3Login(login_url, console.log, console.log, console.log, console.log, console.log, function (resp) {
               console.log(resp);
               window.location.replace(resp.redirect_url);
@@ -119,9 +119,9 @@ Add some javascript to handle login:
       }
     }
 
-You can access signup using {% url 'web3auth_signup' %}.
+You can access signup using {% url 'scatterauth_signup' %}.
 
-If you have any questions left, head to the example app https://github.com/Bearle/django-web3-auth/tree/master/example
+If you have any questions left, head to the example app https://github.com/Bearle/django-scatter-auth/tree/master/example
 
 
 

docs/conf.py

@@ -22,7 +22,7 @@
 parent = os.path.dirname(cwd)
 sys.path.append(parent)
 
-import web3auth
+import scatterauth
 
 # -- General configuration -----------------------------------------------------
 
@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = web3auth.__version__
+version = scatterauth.__version__
 # The full version, including alpha/beta/rc tags.
-release = web3auth.__version__
+release = scatterauth.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

example/README.md

@@ -1,4 +1,4 @@
-Example Project for scatter-auth
+Example Project for django-scatter-auth
 
 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.
 

example/example/settings.py

@@ -36,7 +36,7 @@
     'django.contrib.messages',
     'django.contrib.staticfiles',
 
-    'web3auth',
+    'scatterauth',
 
     # if your app has other dependencies that need to be added to the site
     # they should be added here
@@ -111,7 +111,7 @@
 
 AUTHENTICATION_BACKENDS = [
     'django.contrib.auth.backends.ModelBackend',
-    'web3auth.backend.Web3Backend'
+    'scatterauth.backend.Web3Backend'
 ]
 # Internationalization
 # https://docs.djangoproject.com/en/1.9/topics/i18n/

example/example/urls.py

@@ -38,5 +38,5 @@ def auto_login(request):
     url(r'^$', RedirectView.as_view(url='/login')),
     url(r'^login/', login, name='login'),
     url(r'^auto_login/', auto_login, name='autologin'),
-    url(r'', include('web3auth.urls')),
+    url(r'', include('scatterauth.urls')),
 ]

example/templates/web3auth/base.html

@@ -4,7 +4,7 @@
 <head>
   <meta charset="utf-8">
   <meta http-equiv="x-ua-compatible" content="ie=edge">
-  <title>{% block title %}Django-Web3-Auth{% endblock title %}</title>
+  <title>{% block title %}Django-Scatter-Auth{% endblock title %}</title>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta name="description" content="">
   <meta name="author" content="">
@@ -33,7 +33,7 @@
             aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>
     </button>
-    <a class="navbar-brand" href="#">Django web3 auth</a>
+    <a class="navbar-brand" href="#">Django Scatter auth</a>
 
     <div class="collapse navbar-collapse" id="navbarSupportedContent">
       <ul class="navbar-nav mr-auto">
@@ -68,7 +68,7 @@
     <div class="row m-t-2">
       <p>Use this document as a way to quick start any new project.</p>
       <p>The current template is loaded from
-        <code>django-web3-auth/example/templates/base.html</code>. </p>
+        <code>django-scatter-auth/example/templates/base.html</code>. </p>
       <p>Whenever you overwrite the contents of <code>django-web3-auth/web3auth/urls.py</code> with your
         own content, you should see it here.</p>
     </div>
@@ -109,7 +109,7 @@
 
   </script>
   <!-- Your stuff: Third-party javascript libraries go here -->
-  <script src="{% static 'web3auth/js/web3auth.js' %}"></script>
+  <script src="{% static 'web3auth/js/scatterauth.js' %}"></script>
 
 {% endblock javascript %}
 </body>

web3auth/__init__.py scatterauth/__init__.py

@@ -2,4 +2,4 @@
 
 
 class Web3AuthConfig(AppConfig):
-    name = 'web3auth'
+    name = 'scatterauth'

web3auth/admin.py scatterauth/admin.py

@@ -1,7 +1,7 @@
 from django.contrib.auth import get_user_model, backends
 
-from web3auth.utils import validate_signature
-from web3auth.settings import app_settings
+from scatterauth.utils import validate_signature
+from scatterauth.settings import app_settings
 
 class Web3Backend(backends.ModelBackend):
     def authenticate(self, request, address=None, pubkey=None, token=None, signature=None):

web3auth/apps.py scatterauth/apps.py

@@ -4,7 +4,7 @@
 from django.contrib.auth import authenticate, get_user_model
 
 from django.utils.translation import ugettext_lazy as _
-from web3auth.settings import app_settings
+from scatterauth.settings import app_settings
 
 
 class LoginForm(forms.Form):

web3auth/backend.py scatterauth/backend.py

@@ -52,22 +52,13 @@ function loginWithSignature(pubkey, signature, address, login_url, onLoginReques
     request.send(formData);
 }
 
-function checkWeb3(callback) {
-    web3.eth.getAccounts((err, accounts) => { // Check for wallet being locked
-        if (err) {
-            throw err;
-        }
-        callback(accounts.length !== 0);
-    });
-}
-
 function scatterLogin(login_url, onTokenRequestFail, onTokenSignFail, onTokenSignSuccess, // used in this function
                       onLoginRequestError, onLoginFail, onLoginSuccess) {
     // used in loginWithSignature
 
     // 1. Retrieve arbitrary login token from server
-    // 2. Sign it using web3
-    // 3. Send signed message & your eth address to server
+    // 2. Sign it using scatter
+    // 3. Send signed message & your eos account name & public key to server
     // 4. If server validates that you signature is valid
     // 4.1 The user with an according eth address is found - you are logged in
     // 4.2 The user with an according eth address is NOT found - you are redirected to signup page

web3auth/forms.py scatterauth/forms.py

@@ -1,6 +1,6 @@
 from django.conf.urls import url
 
-from web3auth import views
+from scatterauth import views
 
 urlpatterns = [
     url(r'^login_api/$', views.login_api, name='web3auth_login_api'),