================
djangocms-helper
================
|Gitter| |PyPiVersion| |PyVersion| |Status| |TestCoverage| |CodeClimate| |License|
******************************************
Helper for django applications development
******************************************
djangocms-helper is a set of commands and helper methods
to make developing and testing reusable Django applications easier.
Being born in the django CMS ecosystem, it provides a lot of utility
functions to develop, run and test django CMS applications.
It's a modified version of django CMS's own ``develop.py`` script, modified
to handle generic application development process.
Supported versions
==================
Python: 2.7, 3.5, 3.6, 3.7
Django: 1.11 - 2,2
django CMS: 3.4 - 3.7
Newer versions might work but are not tested yet.
.. warning:: Starting from version 1.2, compatibility with Python 3.4, Django<=1.11 and
django CMS<=3.4 has been dropped. Pin your test requirements accordingly
(``djangocms-helper<1.2``).
.. warning:: Starting from version 1.1, nose test runner has been dropped.
Pin your test requirements accordingly (``djangocms-helper<1.0``).
Common options
==============
* ``--cms``: Loads configuration to properly run a django CMS-based application;
* ``--extra-settings``: Path to a helper file to set extra settings; see
`Settings section <https://djangocms-helper.readthedocs.io/en/develop/settings.html>`_
for details;
*****
Usage
*****
The command **must** be executed in the main plugin directory (i.e. in the same
directory as the ``setup.py`` file) as it needs to import files relative to the
current directory.
The basic command structure is::
djangocms-helper <application> <command> [options ...]
where **<application>** is the django application name and **<command>** is one
of the available commands. Options vary for each command.
Base test class
===============
A base test class is available to provide helpers and methods that
implements repetitive tasks during development or compatibility shims
(especially for django CMS).
.. warning:: Changes in version 1.2 **might** reduce the number of queries executed in tests
rendering plugins.
If you are using ``assertNumQueries`` (or similar), this may
yield unexpected failures.
Please check your code before upgrading djangocms-helper.
*************
Bootstrapping
*************
To bootstrap a project using ``djangocms-helper`` you may want to have a look at `cookiecutter-djangopackage-helper <https://github.com/nephila/cookiecutter-djangopackage-helper>`_, a `cookiecutter <https://github.com/audreyr/cookiecutter>`_ template for ``djangocms-helper``.
To use it follows `usage instructions <https://github.com/nephila/cookiecutter-djangopackage-helper#usage>`_
******
Runner
******
By using the integrated runned in the settings file you'll be able to run
the commands without invoking ``djangocms-helper``: see
`Integrate runner <https://djangocms-helper.readthedocs.io/en/develop/runner.html>`_
for reference.
************
Installation
************
Installing from pip::
pip install djangocms-helper
Installing from source::
pip install git+https://github.com/nephila/djangocms-helper#egg=djangocms-helper
Requirements
============
* django CMS optional; required only to work with ``--cms`` option
* docopt
* tox
* dj-database-url
*************
Documentation
*************
Documentation is available on `readthedocs <https://djangocms-helper.readthedocs.io>`_.
*******
Authors
*******
``djangocms-helper`` was written by `Iacopo Spalletti <i.spalletti@nephila.it>`_ with help from
other contributors.
Thanks
======
The general logic and part of the code of the whole application is heavily taken from
`django CMS's <https://github.com/divio/django-cms>`_ own ``develop.py`` so all the contributors
deserve a huge thanks for their work.
.. |Gitter| image:: https://img.shields.io/badge/GITTER-join%20chat-brightgreen.svg?style=flat-square
:target: https://gitter.im/nephila/applications
:alt: Join the Gitter chat
.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-helper.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-helper
:alt: Latest PyPI version
.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-helper.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-helper
:alt: Python versions
.. |Status| image:: https://img.shields.io/travis/nephila/djangocms-helper.svg?style=flat-square
:target: https://travis-ci.org/nephila/djangocms-helper
:alt: Latest Travis CI build status
.. |TestCoverage| image:: https://img.shields.io/coveralls/nephila/djangocms-helper/master.svg?style=flat-square
:target: https://coveralls.io/r/nephila/djangocms-helper?branch=master
:alt: Test coverage
.. |License| image:: https://img.shields.io/github/license/nephila/djangocms-helper.svg?style=flat-square
:target: https://pypi.python.org/pypi/djangocms-helper/
:alt: License
.. |CodeClimate| image:: https://codeclimate.com/github/nephila/djangocms-helper/badges/gpa.svg?style=flat-square
:target: https://codeclimate.com/github/nephila/djangocms-helper
:alt: Code Climate
Raw data
{
"_id": null,
"home_page": "https://github.com/nephila/djangocms-helper",
"name": "djangocms-helper",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Iacopo Spalletti",
"author_email": "i.spalletti@nephila.it",
"download_url": "https://files.pythonhosted.org/packages/3d/10/23dbc17a45803b6fda624868b5ee56d343c0f3168af984b3338cb795a49d/djangocms-helper-1.2.5.tar.gz",
"platform": "",
"description": "================\ndjangocms-helper\n================\n\n|Gitter| |PyPiVersion| |PyVersion| |Status| |TestCoverage| |CodeClimate| |License|\n\n******************************************\nHelper for django applications development\n******************************************\n\ndjangocms-helper is a set of commands and helper methods\nto make developing and testing reusable Django applications easier.\n\nBeing born in the django CMS ecosystem, it provides a lot of utility\nfunctions to develop, run and test django CMS applications.\n\nIt's a modified version of django CMS's own ``develop.py`` script, modified\nto handle generic application development process.\n\nSupported versions\n==================\n\nPython: 2.7, 3.5, 3.6, 3.7\n\nDjango: 1.11 - 2,2\n\ndjango CMS: 3.4 - 3.7\n\nNewer versions might work but are not tested yet.\n\n.. warning:: Starting from version 1.2, compatibility with Python 3.4, Django<=1.11 and\n django CMS<=3.4 has been dropped. Pin your test requirements accordingly\n (``djangocms-helper<1.2``).\n\n.. warning:: Starting from version 1.1, nose test runner has been dropped.\n Pin your test requirements accordingly (``djangocms-helper<1.0``).\n\nCommon options\n==============\n\n* ``--cms``: Loads configuration to properly run a django CMS-based application;\n* ``--extra-settings``: Path to a helper file to set extra settings; see\n `Settings section <https://djangocms-helper.readthedocs.io/en/develop/settings.html>`_\n for details;\n\n*****\nUsage\n*****\n\nThe command **must** be executed in the main plugin directory (i.e. in the same\ndirectory as the ``setup.py`` file) as it needs to import files relative to the\ncurrent directory.\n\nThe basic command structure is::\n\n djangocms-helper <application> <command> [options ...]\n\nwhere **<application>** is the django application name and **<command>** is one\nof the available commands. Options vary for each command.\n\nBase test class\n===============\n\nA base test class is available to provide helpers and methods that\nimplements repetitive tasks during development or compatibility shims\n(especially for django CMS).\n\n.. warning:: Changes in version 1.2 **might** reduce the number of queries executed in tests\n rendering plugins.\n\n If you are using ``assertNumQueries`` (or similar), this may\n yield unexpected failures.\n\n Please check your code before upgrading djangocms-helper.\n\n*************\nBootstrapping\n*************\n\nTo bootstrap a project using ``djangocms-helper`` you may want to have a look at `cookiecutter-djangopackage-helper <https://github.com/nephila/cookiecutter-djangopackage-helper>`_, a `cookiecutter <https://github.com/audreyr/cookiecutter>`_ template for ``djangocms-helper``.\n\nTo use it follows `usage instructions <https://github.com/nephila/cookiecutter-djangopackage-helper#usage>`_\n\n******\nRunner\n******\n\nBy using the integrated runned in the settings file you'll be able to run\nthe commands without invoking ``djangocms-helper``: see\n`Integrate runner <https://djangocms-helper.readthedocs.io/en/develop/runner.html>`_\nfor reference.\n\n************\nInstallation\n************\n\nInstalling from pip::\n\n pip install djangocms-helper\n\nInstalling from source::\n\n pip install git+https://github.com/nephila/djangocms-helper#egg=djangocms-helper\n\nRequirements\n============\n\n* django CMS optional; required only to work with ``--cms`` option\n* docopt\n* tox\n* dj-database-url\n\n*************\nDocumentation\n*************\n\nDocumentation is available on `readthedocs <https://djangocms-helper.readthedocs.io>`_.\n\n\n*******\nAuthors\n*******\n\n``djangocms-helper`` was written by `Iacopo Spalletti <i.spalletti@nephila.it>`_ with help from\nother contributors.\n\nThanks\n======\n\nThe general logic and part of the code of the whole application is heavily taken from\n`django CMS's <https://github.com/divio/django-cms>`_ own ``develop.py`` so all the contributors\ndeserve a huge thanks for their work.\n\n\n\n.. |Gitter| image:: https://img.shields.io/badge/GITTER-join%20chat-brightgreen.svg?style=flat-square\n :target: https://gitter.im/nephila/applications\n :alt: Join the Gitter chat\n\n.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-helper.svg?style=flat-square\n :target: https://pypi.python.org/pypi/djangocms-helper\n :alt: Latest PyPI version\n\n.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-helper.svg?style=flat-square\n :target: https://pypi.python.org/pypi/djangocms-helper\n :alt: Python versions\n\n.. |Status| image:: https://img.shields.io/travis/nephila/djangocms-helper.svg?style=flat-square\n :target: https://travis-ci.org/nephila/djangocms-helper\n :alt: Latest Travis CI build status\n\n.. |TestCoverage| image:: https://img.shields.io/coveralls/nephila/djangocms-helper/master.svg?style=flat-square\n :target: https://coveralls.io/r/nephila/djangocms-helper?branch=master\n :alt: Test coverage\n\n.. |License| image:: https://img.shields.io/github/license/nephila/djangocms-helper.svg?style=flat-square\n :target: https://pypi.python.org/pypi/djangocms-helper/\n :alt: License\n\n.. |CodeClimate| image:: https://codeclimate.com/github/nephila/djangocms-helper/badges/gpa.svg?style=flat-square\n :target: https://codeclimate.com/github/nephila/djangocms-helper\n :alt: Code Climate\n\n\n",
"bugtrack_url": null,
"license": "GPLv2+",
"summary": "Helper for django applications development",
"version": "1.2.5",
"project_urls": {
"Homepage": "https://github.com/nephila/djangocms-helper"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0eb1f78aa1cf009670712c015cbe2badddf55c61036f97a6c03511347eeebb6a",
"md5": "659202e13cc667b0760fc5ba378eb0a9",
"sha256": "e7e81db034d3f4cb8c55a17d26b8851775e60788e58849bc0fc5537ce562f3c7"
},
"downloads": -1,
"filename": "djangocms_helper-1.2.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "659202e13cc667b0760fc5ba378eb0a9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 46776,
"upload_time": "2019-08-16T19:10:53",
"upload_time_iso_8601": "2019-08-16T19:10:53.152622Z",
"url": "https://files.pythonhosted.org/packages/0e/b1/f78aa1cf009670712c015cbe2badddf55c61036f97a6c03511347eeebb6a/djangocms_helper-1.2.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d1023dbc17a45803b6fda624868b5ee56d343c0f3168af984b3338cb795a49d",
"md5": "bf45453e97d5d460344c747dabf9850a",
"sha256": "41973cb2effdfc05492ceb427afeb23caf6c126a334c9684e4c60b113504d249"
},
"downloads": -1,
"filename": "djangocms-helper-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "bf45453e97d5d460344c747dabf9850a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40509,
"upload_time": "2019-08-16T19:10:55",
"upload_time_iso_8601": "2019-08-16T19:10:55.426149Z",
"url": "https://files.pythonhosted.org/packages/3d/10/23dbc17a45803b6fda624868b5ee56d343c0f3168af984b3338cb795a49d/djangocms-helper-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-08-16 19:10:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nephila",
"github_project": "djangocms-helper",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "djangocms-helper"
}
JSON
