Skip to main content

A swatch page for Bootstrap styling

Project description

=============================
Django Bootstrap Swatches
=============================

.. image:: https://badge.fury.io/py/dj-bootstrap-swatches.svg
:target: https://badge.fury.io/py/dj-bootstrap-swatches

.. image:: https://travis-ci.org/bwarren2/dj-bootstrap-swatches.svg?branch=master
:target: https://travis-ci.org/bwarren2/dj-bootstrap-swatches

.. image:: https://codecov.io/gh/bwarren2/dj-bootstrap-swatches/branch/master/graph/badge.svg
:target: https://codecov.io/gh/bwarren2/dj-bootstrap-swatches

A swatch page for Bootstrap styling

Documentation
-------------

The full documentation is at https://dj-bootstrap-swatches.readthedocs.io.

Quickstart
----------

Install Django Bootstrap Swatches::

pip install dj-bootstrap-swatches

Add it to your `INSTALLED_APPS`:

.. code-block:: python

INSTALLED_APPS = (
...
'dj_bootstrap_swatches.apps.DjBootstrapSwatchesConfig',
...
)

Add Django Bootstrap Swatches's URL patterns:

.. code-block:: python

from dj_bootstrap_swatches import urls as dj_bootstrap_swatches_urls


urlpatterns = [
...
url(r'^bootswatch/', include(dj_bootstrap_swatches_urls)),
...
]

Per "Two Scoops of Django" design patterns, the default swatch page tries to extend a base template called `base.html` and a block called `content`. If this isn't your practice, you'll need to adjust things to fit.

Features
--------


* TODO

Development
--------

Run a fake server with the test settings and nav to `http://localhost:8000/3`

.. code-block:: none

python manage.py runserver --settings tests.settings


Running Tests
-------------

Does the code actually work?

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits
-------

Tools used in rendering this package:

* Cookiecutter_
* `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage

Compilation of components due to Thomas Park via [Bootswatch](https://bootswatch.com/default/).




History
-------

0.1.0 (2017-05-26)
++++++++++++++++++

* First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dj-bootstrap-swatches, version 0.6.0
Filename, size & hash File type Python version Upload date
dj_bootstrap_swatches-0.6.0-py2.py3-none-any.whl (13.4 kB) View hashes Wheel 2.7
dj-bootstrap-swatches-0.6.0.tar.gz (13.9 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page