Getting Started

Installation is simple using pip:

$ pip install django-glitter-documents

Add glitter_documents to your site’s INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'glitter_documents',
    ...
]

And finally, remember to run the migrations:

$ ./manage.py migrate

Developing

Getting started on improving Django Glitter Documents is pretty straight forward. Presuming you’re using virtualenvwrapper and The Developer Society Dev Tools:

$ dev-clone git@github.com:developersociety/django-glitter-documents.git
$ make reset

Please remember to run make format before you commit, and tox before pushing the changes you make:

$ make format
$ git add .
$ git commit -m 'Made it do something awesome!'
$ tox
$ git push

Releasing

Releasing a new version of the project to PyPi is fairly straight forward.

First, make sure you have the correct credentials for PyPi correctly configued on your machine.

Update and commit the Version History in the README.

Then, use bumpversion to increment the version numbers in the project. This will also create a commit and a tag automatically for the new version. For example, to increment the version numbers for a ‘patch’ release:

$ bumpversion patch
$ git push --tags origin master

bumpversion can increment ‘patch’, ‘minor’ or ‘major’ version numbers:

$ bumpversion [patch | minor | major]

Then release the new version to PyPi:

$ make release

Version History