Welcome to HTML dumper’s documentation!¶
Contents:
HTML dumper¶
Dumps html pages and their corresponding assets into a tar file
Documentation¶
The full documentation is at https://django-html-dumper.readthedocs.io.
Quickstart¶
Install HTML dumper:
pip install django-html-dumper
Add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'html_dumper.apps.HtmlDumperConfig',
...
)
Features¶
- Add a django command dump_html
This will create a directory HTML_OUTPUT (name can be customized via settings.SITE_OUTPUT_DIRECTORY) which will contain :
- the content of the page under the given urls for all available languages
- the static folder (copied from the output of collectstatic, beware of all the admin assets...)
Running Tests¶
Does the code actually work?
Installation¶
At the command line:
$ easy_install django-html-dumper
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv django-html-dumper
$ pip install django-html-dumper
Usage¶
To use HTML dumper in a project, add it to your INSTALLED_APPS:
INSTALLED_APPS = (
...
'html_dumper.apps.HtmlDumperConfig',
...
)
This app adds a django command !
You can use either relative or absolute URLs. Note that you might need to add ‘testserver’ in your settings.ALLOWED_HOSTS.
This will create a directory HTML_OUTPUT (name can be customized via settings.SITE_OUTPUT_DIRECTORY) which will contain :
- the content of the page under the given urls for all available languages
- the static folder (copied from the output of collectstatic, beware of all the admin assets...)
You can have a look at the example folder to give it a try.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/adrienbrunet/django-html-dumper/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
HTML dumper could always use more documentation, whether as part of the official HTML dumper 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/adrienbrunet/django-html-dumper/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up django-html-dumper for local development.
Fork the django-html-dumper repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/django-html-dumper.git
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-html-dumper $ cd django-html-dumper/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 html_dumper tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/adrienbrunet/django-html-dumper/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Adrien Brunet <adrien@emencia.com>
Contributors¶
None yet. Why not be the first?