Welcome to djangocms-usersettings2’s documentation!¶
Contents:
djangocms-usersettings2¶
This package integrates django-usersettings2 with django-cms>=3.0.
This allows a site editor to add/modify all usersettings in the frontend editing mode of django CMS and provide your users with a streamlined editing experience.
This project requires django-usersettings2 and django CMS 3.0 or higher to be properly installed and configured. When installing the djangocms-usersettings2 using pip, django-usersettings2 will also be installed automatically.
The full documentation for django-usersettings2 is available at https://django-usersettings2.readthedocs.org.
Quickstart¶
Install djangocms-usersettings2:
pip install djangocms-usersettings2
Add sites, usersettings and djangocms_usersettings2 to INSTALLED_APPS:
INSTALLED_APPS = ( ... 'django.contrib.sites', 'usersettings', 'djangocms_usersettings2', ... )
3. UserSettingsToolbar will be automatically loaded as long as the CMS_TOOLBARS is not set (or set to None). Or you can add usersettings.cms_toolbar.UserSettingsToolbar to CMS_TOOLBARS settings:
CMS_TOOLBARS = [
# CMS Toolbars
...
# djangocms-usersettings2 Toolbar
'djangocms_usersettings2.cms_toolbar.UserSettingsToolbar',
]
Installation¶
Install djangocms-usersettings2:
pip install djangocms-usersettings2
Add sites, usersettings and djangocms_usersettings2 to INSTALLED_APPS:
INSTALLED_APPS = ( ... 'sites' 'usersettings', 'djangocms_usersettings2', ... )
3. UserSettingsToolbar will be automatically loaded as long as the CMS_TOOLBARS is not set (or set to None). Or you can add usersettings.cms_toolbar.UserSettingsToolbar to CMS_TOOLBARS settings:
CMS_TOOLBARS = [
# CMS Toolbars
...
# djangocms-usersettings2 Toolbar
'djangocms_usersettings2.cms_toolbar.UserSettingsToolbar',
]
PLEASE NOTE: This project requires django CMS 3.0 or higher to be properly installed and configured. When installing the``djangocms-usersettings2`` using pip, django-usersettings2 will also be installed automatically.
Usage¶
UserSettingsToolbar will be automatically loaded as long as the CMS_TOOLBARS is not set (or set to None). Or you can add usersettings.cms_toolbar.UserSettingsToolbar to CMS_TOOLBARS settings:
CMS_TOOLBARS = [
# CMS Toolbars
...
# djangocms-usersettings2 Toolbar
'djangocms_usersettings2.cms_toolbar.UserSettingsToolbar',
]
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/mishbahr/djangocms-usersettings2/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¶
djangocms-usersettings2 could always use more documentation, whether as part of the official djangocms-usersettings2 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/mishbahr/djangocms-usersettings2/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 djangocms-usersettings2 for local development.
Fork the djangocms-usersettings2 repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/djangocms-usersettings2.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 djangocms-usersettings2 $ cd djangocms-usersettings2/ $ 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.
5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 djangocms_usersettings2 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/mishbahr/djangocms-usersettings2/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Mishbah Razzaque <mishbahx@gmail.com>
Contributors¶
None yet. Why not be the first?