Permalink
Browse files

Version 0.1.5

  • Loading branch information...
1 parent b99ec61 commit 49fc3fed7117288f1e2b88aaa8ae3b3ee6139e7c @klen committed Mar 9, 2011
@@ -1,28 +1,37 @@
-## 2011-02-02 0.1.4
+CHANGES
+=======
+
+## 2011-03-09 0.1.5
+-------------------
+* Fix facebook and yandex backends
+* Move example_project on makesite deploy
+* Change profile mapping order
+* Create docs
+## 2011-02-02 0.1.4
+-------------------
* Fix distribution
## 2011-01-28 0.1.3
-
+-------------------
* Drop netauth middleware
* More simple example project
* More compatable with django 1.2
## 2010-12-13 0.1.0
-
+-------------------
* Thanks for ilblackdragon for fixes
* Register module on pypi
## 2010-12-13 0.0.2
-
+-------------------
* Add example project
* Add tests
## 2010-11-25 0.0.1
-
+-------------------
* First public version.
-
View
@@ -12,7 +12,7 @@ register: _register clean
remove:
sudo pip uninstall $(MODULE)
-upload: _upload clean _commit
+upload: _upload clean _commit doc
test:
cd example_project && ./manage.py test main
@@ -32,3 +32,7 @@ _commit:
_register:
python setup.py register
+
+doc:
+ python setup.py build_sphinx --source-dir=docs/ --build-dir=docs/_build --all-files
+ python setup.py upload_sphinx --upload-dir=docs/_build/html
View
@@ -1,14 +1,12 @@
-.. -*- mode: rst -*-
-
django-netauth
##############
-**Django netauth** is django application that allows authenticate users through OpenID/OAuth/Facebook/Vkontakte.
+**Django netauth** is django application that allows authenticate users through OpenID/OAuth/Google/Twitter/Facebook/Vkontakte.
.. contents::
Requirements
--------------
+=============
- python >= 2.5
- django >= 1.2
@@ -17,15 +15,15 @@ Requirements
Installation
-------------
+=============
**Django netauth** should be installed using pip: ::
pip install django-netauth
Setup
-------
+======
- Add 'netauth' to INSTALLED_APPS ::
@@ -44,26 +42,24 @@ Setup
- See services setup bellow.
-- See services setup bellow.
-
Use netauth
-------------
+============
1) Use url '/auth/login' as login point in your site
2) Use template tag 'netauth_widget'
3) Create custom interface
Extra fields
--------------
+=============
In order to fill extra fields that may be required by your user profile, you need to setup couple of variables in settings.py of your project.
The name of variable should be uppercased name of backend + "_PROFILE_MAPPING". For example: GOOGLE_PROFILE_MAPPING, TWITTER_PROFILE_MAPPING, etc..
The value of this variable must be dictionary with name of the field on the provider side and its value must be name of your form field. For example:
-TWITTER_PROFILE_MAPPING = { 'screen_name': 'username', }
+TWITTER_PROFILE_MAPPING = { 'username': 'screen_name', }
Here you can see that 'screen_name' is what you asking from twitter, in your EXTRA_FORM you will see the value of this under key 'username'. This is because every authentication method can provide different names for its data and you need to unify it.
@@ -102,10 +98,39 @@ Vkontakte
- Add VKONTAKTE_APPLICATION_ID and VKONTAKTE_APPLICATION_SECRET in your settings file
+Changes
+=======
+
+Make sure you`ve read the following document if you are upgrading from previous versions of scss:
+
+http://packages.python.org/django-netauth/changes.html
+
+
Note
------
+=====
You need to setup messages-framework_ as described in django documentation
+Bug tracker
+===========
+
+If you have any suggestions, bug reports or
+annoyances please report them to the issue tracker
+at https://github.com/klen/django-netauth/issues
+
+
+Contributing
+============
+
+Development of django-netauth happens at github: https://github.com/klen/django-netauth
+
+
+License
+=======
+
+Licensed under a `GNU lesser general public license`_.
+
+
+.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
.. _messages-framework: http://docs.djangoproject.com/en/dev/ref/contrib/messages/#ref-contrib-messages
View
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-scss.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-scss.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/python-scss"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-scss"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
View
Oops, something went wrong.

0 comments on commit 49fc3fe

Please sign in to comment.