Initial app (#1)

* added initial app

* updated from master

* added aws details in documentation

* updated docs

* updated docs

Author: nikhila05

README.md

@@ -0,0 +1,131 @@
+django-webpacker's documentation:
+=====================================
+
+#badges
+
+Introduction:
+=============
+
+django-webpacker is a django compressor tool which bundles css, js files to a single css, js file with webpack and updates your html files with respective css, js file path.
+
+It supports django-storages to load compressed files from AWS S3.
+
+Source Code is available in Micropyramid Repository(https://github.com/MicroPyramid/django-webpacker).
+
+
+Installation Procedure
+======================
+
+1. Install django-web-packer using the following command::
+
+    pip install django-webpacker
+
+    		(or)
+
+    git clone git://github.com/micropyramid/django-webpacker.git
+
+    cd django-webpacker
+
+    python setup.py install
+
+2. Add app name in project settings.py file::
+
+    INSTALLED_APPS = [
+       '..................',
+       'django-webpacker',
+       '..................'
+    ]
+
+3. Run npm init to intialize npm modules and it will create 'package.json' file which will contain package information. Update file with following dependencies::
+
+     "devDependencies": {
+        "babel": "^6.23.0",
+        "babel-core": "^6.24.0",
+        "babel-loader": "^6.4.1",
+        "css-loader": "^0.28.0",
+        "extract-text-webpack-plugin": "^2.1.0",
+        "file-loader": "^0.11.1",
+        "html-webpack-inline-source-plugin": "0.0.7",
+        "html-webpack-plugin": "^2.28.0",
+        "image-webpack-loader": "^3.3.0",
+        "less-loader": "^4.0.3",
+        "node-sass": "^4.5.2",
+        "react": "^15.4.2",
+        "react-hot-loader": "^1.3.1",
+        "sass-loader": "^6.0.3",
+        "script-loader": "^0.7.0",
+        "style-loader": "^0.16.1",
+        "webpack": "^2.3.3",
+        "webpack-bundle-tracker": "^0.2.0",
+        "webpack-dev-server": "^2.4.2"
+      },
+      "dependencies": {
+        "imports-loader": "^0.7.1",
+        "jquery": "^3.2.1"
+      }
+
+4. Run npm install to install all package dependencies.
+
+    npm install
+
+5. Updates Your html file with the following script, link stylesheet tags.
+
+    <link rel="stylesheet" type="text/css" href="" id="packer_css"/>
+
+    <script id="packer_js" src="" type="text/javascript"></script>
+
+6. Create webpack.config.js file with webpack.config.js file data. Update your project entry points with their respective paths. We can give multiple entry points(i.e separate entry point for each app) for the project.  After compressing, separate css, file will be genarated with respective entry point name.
+
+
+7. Add the following details in settings file about compressing css, js files::
+
+    WEB_PACK_FILES = [
+        {'html_file_name': {{ HTML_FILE_RELATIVE_PATH }},
+         'webpack_js': {{ WEBPACK_ENTRY_POINT_KEY_NAME }},
+        },
+        {'html_file_name': {{ HTML_FILE_RELATIVE_PATH }},
+         'webpack_js': {{ WEBPACK_ENTRY_POINT_KEY_NAME }},
+         },
+        {'html_file_name': {{ HTML_FILE_RELATIVE_PATH }}',
+         'webpack_js': {{ WEBPACK_ENTRY_POINT_KEY_NAME }},
+         },
+    ]
+
+8. Run python manage.py compress_css_js_files to generate compressed css, js file. It will updates html file with respective compressed css, js files. Link, script tags will be loaded with compressed css, js files.
+
+
+9. If you use django storages, then add the following variable to settings file to load compressed css, js files from s3.
+
+
+    # AWS details
+
+    AWS_ACCESS_KEY_ID = "Your AWS Access Key"
+
+    AWS_SECRET_ACCESS_KEY = "Your AWS Secret Key"
+
+    AWS_BUCKET_NAME = "Your AWS Bucket Name"
+
+    ENABLE_DJANGO_WEBPACK_AWS = True
+
+Modules used:
+-------------
+
+    * Django  = 1.9.6
+
+
+We are always looking to help you customize the whole or part of the code as you like.
+
+
+Visit our Django Development page `Here`_
+
+
+We welcome your feedback and support, raise `github ticket`_ if you want to report a bug. Need new features? `Contact us here`_
+
+.. _contact us here: https://micropyramid.com/contact-us/
+.. _github ticket: https://github.com/MicroPyramid/django-webpacker/issues
+.. _Here: https://micropyramid.com/django-development-services/
+
+    or
+
+mailto:: "hello@micropyramid.com"
+

README.rst

@@ -0,0 +1,79 @@
+from django.core.management.base import BaseCommand
+import json
+import subprocess
+
+try:
+    from boto.s3.connection import S3Connection
+    from boto.s3.key import Key
+except:
+    pass
+
+from django.conf import settings
+import mimetypes
+import os
+
+
+def call_subprocess(command):
+    proc = subprocess.Popen(command,
+                        shell=True,
+                        stdin=subprocess.PIPE,
+                        stdout=subprocess.PIPE,
+                        )
+
+
+def upload_to_s3(css_file):
+    bucket_name = settings.AWS_BUCKET_NAME
+    conn = S3Connection(settings.AWS_ACCESS_KEY_ID, settings.AWS_SECRET_ACCESS_KEY)
+
+    folder = 'webpack_bundles/'
+    bucket = conn.get_bucket(bucket_name=bucket_name)
+
+    filename = css_file.split('/')[-1]
+    file_obj = open(css_file, 'r')
+    content = file_obj.read()
+
+    key = folder + filename
+    bucket = conn.get_bucket(bucket_name=bucket_name)
+    mime = mimetypes.guess_type(filename)[0]
+    k = Key(bucket)
+    k.key = key  # folder + filename
+    k.set_metadata("Content-Type", mime)
+    k.set_contents_from_string(content)
+    public_read = True
+    if public_read:
+        k.set_acl("public-read")
+
+
+
+class Command(BaseCommand):
+    args = '<filename>'
+    help = 'Loads the initial data in to database'
+
+    def handle(self, *args, **options):
+        call_subprocess('./node_modules/.bin/webpack --config webpack.config.js')
+
+
+        for each in settings.WEB_PACK_FILES:
+            directory = settings.BASE_DIR + '/static/webpack_bundles/'
+            css_file = max([os.path.join(directory, d) for d in os.listdir(directory) if d.startswith(each['webpack_js']) and d.endswith('css')], key=os.path.getmtime)
+            js_file = max([os.path.join(directory, d) for d in os.listdir(directory) if d.startswith(each['webpack_js']) and d.endswith('js')], key=os.path.getmtime)
+
+            if settings.ENABLE_DJANGO_WEBPACK_S3_STORAGES:
+                upload_to_s3(css_file)
+                upload_to_s3(js_file)
+
+            import re
+            regex = r'(.*?<link rel="stylesheet" type="text/css" href=")(.*?)(" id="packer_css"/>.*?<script id="packer_js" src=")(.*?)(" type="text/javascript"></script>.*)'
+
+            with open(each['html_file_name'], 'r+') as f:
+                content = f.read()
+                m = re.match(regex, content, re.DOTALL)
+                href = settings.STATIC_URL + css_file.split('/static/')[-1]
+                src = settings.STATIC_URL + js_file.split('/static/')[-1]
+                content = m.group(1) + href + m.group(3) + src + m.group(5)
+
+            with open(each['html_file_name'], 'w') as f:
+                f.write(content)
+
+        result = {'message': "Successfully Created Compressed CSS, JS Files"}
+        return json.dumps(result)

django_webpacker/__init__.py

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@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/MicroSite.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MicroSite.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/MicroSite"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MicroSite"
+	@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."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@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."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."