Saravanan666/pypi-org huggingface dataset:
Package: django-cmd
Django only includes thedjango-admin.
They prefer to not include multiple ways to do the same thing,
but I really want to spell itdjango.
I also wanted to be able to configure a
default settings file in asetup.cfgconfiguration file.Usagepipinstalldjango-cmddjangostartprojectOnce installed, you can use thedjangocommand
the same as you would normally use thedjango-admincommand.
Additionally, you can add a section like this to asetup.cfgfile
to configure theDJANGO_SETTINGS_MODULEthat you would like to use when no other is specified.[django]settings_module=myproject.settingsThat’s it! Have fun!
Package: django-cmd-controller
Cmd Controllercmd_controller is a Django app to help run the custom management command in a more convenient way,
Most of the time during deployment, develpers need to run some django management scripts,
some script need to run only once and some need to run again and again.
Running some scripts again and again may corrupt the application. The cmd_controller help to mark a script reentrant,
while during the creation of the script and skips the scripts which are not reentrant.Quick startAdd "cmd_controller" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = [
...
'cmd_controller',
]Runpython manage.py migrateto create the cmd_controller models.How to use it.
import cmd_utils import check_command in your custom django command, and decerate the handle
method and pass the script name as first parameter and Boolean value as second parameter. Pass True if the
script can run again and again(reentrant), False for scripts run only once.@check_command(os.path.basename(file).split(".")[0], )  # need to run scripts multiple times
@check_command(os.path.basename(file).split(".")[0], ) # should run only once.app/management/commands/<custom_command.py>if the script should run only once.import os
from django.core.management.base import BaseCommand
from cmd_controller.cmd_utils import check_commandclass Command(BaseCommand):
help = 'test custom command'@check_command(os.path.basename(__file__).split(".")[0], False)
def handle(self, *args, **options):
    # your custom command logicif the script is reentrantclass Command(BaseCommand):
help = 'test custom command'@check_command(os.path.basename(__file__).split(".")[0], True)
def handle(self, *args, **options):
    # your custom command logicrun the scriptpython manage.py custom_command.py
Package: django-cml
CML is a reusable Django app for data exchange in CommerceML 2 standard.RequirementsPython 3.3, 3.4, 3.5, 3.6Django 2.xQuick startInstall using pip:pip install django-cmlOr clone the repo and add to yourPYTHONPATH:git clone https://github.com/ArtemiusUA/django-cml.gitAdd “cml” to yourINSTALLED_APPSsetting like this:INSTALLED_APPS = [
    ...
    'cml',
]Include the cml URLconf in your projecturls.pylike this:re_path(r'^cml/', include('cml.urls')),Runpython manage.py migrateto create the cml models.Create acml-pipelines.pyfile withpython manage.py cmlpipelinesand add it to settings file like this:CML_PROJECT_PIPELINES = 'project.cml_pipelines'Modify pipeline objects for your needs to stack this with your models.
Package: django-cml2
CML is a reusable Django app for data exchange in CommerceML 2 standard.This packet is available here:https://pypi.org/project/django-cml2RequirementsPython 3.3, 3.4, 3.5, 3.6Django 3.2Quick startInstall using pip:pip install django-cml2or clone the repo and add to your virtual environmentvenv:# cd <your_project>
# source venv/bin/activate

git clone https://github.com/sergey-gru/django-cml2.git
pip install --editable django-cml2Add ‘cml’ to yoursettings.pylike this:INSTALLED_APPS = [
    ...
    'cml',
]Include the cml URLconf in your projecturls.pylike this:urlpatterns = [
    ...
    path('cml', include('cml.urls')),
]To create cml models run:python manage.py migrate cmlCreate a template ofcml_delegate.py:python manage.py cml_initRegister it tosettings.pyfile like this:CML_USER_DELEGATE = 'cml_delegate'
# CML_USER_DELEGATE = 'app.cml_delegate'Modify methods to stack new cml packet with your django models.Add logger settings to yoursettings.py:LOGGING = {
    'version': 1,
    ...

    'handlers': {
        'console': {...},
        'log_debug': {...},
        'log_info': {...},
    },

    'loggers': {
        ...

        # Logging important change process
        'cml.views': {
            'handlers': ['console', 'log_debug', 'log_info'] if DEBUG else ['log_info'],
            'level': 'DEBUG',
            'propagate': False,
        },
        'cml.utils': {
            'handlers': ['console', 'log_debug', 'log_info'] if DEBUG else ['log_info'],
            'level': 'INFO',
            'propagate': False,
        },
    }
}Release notes1.0.0 This version was forked fromhttps://github.com/ArtemiusUA/django-cml
Package: djangocms-4-migration
django CMS 4 MigrationWarning:If the migration process fails to complete you will not be able to undo the changes without reloading a database backup. We cannot be held accountable for any data loss sustained when running the commands provided in this project. Please keep a database backup before running any commands provided by this package.When do I need this package?This package is designed to migrate a django CMS 3.5+ project to django CMS 4.0.What does this package do?Keeps any draft and published content, ensuring that any new draft changes are kept as a new draft version in djangocms_versioning.LimitationsDue to the nature of the changes between django CMS 3.5+ and 4.0 the package will fail to function if an incompatible package is installed.This may require you to:Fork or copy and modify this package to work with any bespoke requirements your project has (we may accept these changes back for popular packages as a configurable option)Ensure that all installed packages for your project arePrerequisitesRequire knowledge of the changes and new features in 4.0:New cms app configurationRevised Page, Title (Now named PageContent) and Placeholder relationshipsRequires knowledge of django CMS VersioningGrouper and content model termsUnderstanding how versioning selects published contentInstall the following packagesThe following packages are not yet officially released, they need to be installed directly from the repository. We need your help to make packages v4.0 compatible and to provide documentation for the wider community!django CMS 4.0pip install http://github.com/divio/django-cms/tarball/release/4.0.x#egg=django-cmsdjangocms-text-ckeditorpip install https://github.com/divio/djangocms-text-ckeditor/tarball/support/4.0.x#egg=djangocms-text-ckeditordjangocms-versioningpip install https://github.com/divio/djangocms-versioning/tarball/master#egg=djangocms-versioningdjangocms-aliaspip install https://github.com/divio/djangocms-alias/tarball/master#egg=djangocms-aliasInstallationWarning: This package can leave your DB in a corrupted state if used incorrectly, be sure to backup any databases prior to running any commands listed here!First install this package in your projectpip install djangocms-4-migrationRunningSimply run the following command to run the data migration.Note:This command calls the django migrate command, this is because it has to run commands that save information that would have been lost by running the cms migrations directly.python manage.py cms4_migrationCommon solutions for django CMS 4.0 compatibilityImport PageContent in a backwards compatible way (Title).# django CMS v4try:fromcms.modelsimportPageContent# django CMS 3.xexceptImportError:fromcms.modelsimportTitleasPageContent
Package: djangocms-accordion
djangocms-accordion==============An accordion plugin for django CMS. UsesInstallation------------This plugin requires `django CMS` 2.4 or higher to be properly installed.Also, it assumes you have `Cl.Accordion`_ installed in your project.* In your projects `virtualenv`_, run ``pip install djangocms-accordion``.* Add ``'djangocms_accordion'`` to your ``INSTALLED_APPS`` setting.* Run ``manage.py migrate djangocms_accordion``.Usage-----.. _Cl.Accordion: http://classjs-plugins.readthedocs.org/en/latest/src/cl.accordion.html
Package: djangocms-admindocs-style
Adds DjangoCMS Admin Styles to the admindocs.DocumentationThe full documentation is athttps://djangocms-admindocs-style.readthedocs.org.QuickstartInstall djangocms-admindocs-style:pip install djangocms-admindocs-styleThen use it in a project by adding it to your installed apps before ‘django.contrib.admin’ and ‘djangocms_admin_style’:INSTALLED_APPS = [
    ...
    'djangocms_admindocs_style',
    'djangocms_admin_style',
    'django.contrib.admin',
    'django.contrib.admindocs',
    ...
]FeaturesAdds styles fromdjangomcs_admin_style <https://github.com/divio/djangocms-admin-style>to thedjango.contrib.admindocsapp.Makesdjango.contrib.admindocstemplates all inherit from a single base template that you can extend:admin/base_admin_docs.htmlAdds a link to the DjangoCMS toolbar to a sidebar itemRunning TestsDoes the code actually work?source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.pyCompiling CSSMake suresasscis installed and run:npm run sassHistory0.1.0 (2016-04-05)First release on PyPI.
Package: djangocms-aldryn-categories
Aldryn CategoriesContinuation of the deprecated projectDivio Aldryn search.Aldryn Categories is a simple, Aldryn-compatible project that provides
hierarchicalcategoriesas an independent model in your project. Categories
are similar totags, but are structured into a taxonomy. The project is
suitable for I18N projects as Categories are fully translatable.Please see the officialAldryn Categories documentation,
which includes information on installation.Developers should also note that the project maintainsUML diagramsfor this project.ContributingAldryn Categories is a an open-source project. We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your pull
request, please review ourguidelines for Aldryn addons.
Package: djangocms-aldryn-common
Aldryn CommonContinuation of the deprecated projectDivio Aldryn Common.Aldryn Common is a library of helpful utilities for packages in theAldrynecosystem, and is
also aimed at developers ofdjango CMSprojects.It's installed by default in your Aldryn project - you don't need to do anything to install it - and numerous other
Addons will make use of the tools it provides. Feel free to make use of them in your own projects.They include tools for:paginationhandling slugs (cleaning, ensuring uniqueness)managing times and datesas well as a variety of helpful templatetags and more.Settings:ALDRYN_COMMON_PAGINATION_SOFTLIMIT: Soft-limiting search results. If True, querying a page number larger than max. will not fail, but instead return the last available page. Default isTrue.
Package: djangocms-aldryn-forms
Aldryn Forms AppContinuation of the deprecated projectDivio Aldryn Forms.Aldryn Forms allows you to build flexible HTML forms for yourAldrynanddjango CMSprojects, and to integrate them directly in your pages.Forms can be assembled using the form builder, with the familiar simple drag-and-drop interface of the django CMS
plugin system.Submitted data is stored in the Django database, and can be explored and exported using the admin, while forms can
be configured to send a confirmation message to users.ContributingThis is a an open-source project. We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review ourcontribution guidelines.We’re grateful to all contributors who have helped create and maintain this package.
Contributors are listed at thecontributorssection.InstallationAldryn Platform UsersChoose a site you want to install the add-on to from the dashboard. Then go toApps->Install appand clickInstallnext toFormsapp.Redeploy the site.Upgrading from < 2.0Version 2.0 introduced a new model for form data storage calledFormSubmission.
The oldFormDatamodel has been deprecated.
Although theFormDatamodel’s data is still accessible through the admin, all new form data will be stored in the newFormSubmissionmodel.Manuall InstallationRunpip installdjangocms-aldryn-forms.UpdateINSTALLED_APPSwithINSTALLED_APPS = [
    ...
    'aldryn_forms',
    'aldryn_forms.contrib.email_notifications',
    'captcha',
    ...
]Also ensure you define ane-mail backendfor your app.Creating a FormYou can create forms in the admin interface now. Search for the labelAldryn_Forms.Create a CMS page and install theFormsapp there (chooseFormsfrom theAdvanced Settings->Applicationdropdown).Now redeploy/restart the site again.The above CMS site has become a forms POST landing page - a place where submission errors get displayed if there are any.Available Plug-insFormPluginplugin lets you embed certain forms on a CMS page.Fieldsetgroups fields.TextFieldrenders text input.TextAreaFieldrenders text input.HiddenFieldPhoneFieldDateFieldDateTimeLocalFieldTimeFieldNumberFieldEmailFieldFileFieldrenders a file upload input.MultipleFilesFieldImageFieldsame asFileFieldbut validates that the uploaded file is an image.BooleanFieldrenders checkbox.SelectFieldrenders single select input.MultipleSelectFieldMultipleCheckboxSelectFieldrenders multiple checkboxes.CaptchaField
Package: djangocms-aldryn-newsblog
Aldryn News & Blog for django CMSContinuation of the deprecated projectDivio Aldryn News&Blog.Aldryn News & Blog is anAldryn-compatible news and
weblog application fordjango CMS.Content editorslooking for documentation on how to use the editing
interface should refer to ouruser manualsection.Django developerswho want to learn more about django CMS, as well as
how to install, configure and customize it for their own projects should
refer to thedocumentationsections.Aldryn News & Blog is intended to serve as a model of good practice for
development of django CMS and Aldryn applications.Installation & UpdatesPlease head over to ourdocumentationfor all the details on how to install,
configure and use Aldryn News & Blog.You can also find instructions onhow to upgradefrom earlier versions.ContributingThis is a an open-source project. We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review ourcontribution guidelines.We’re grateful to all contributors who have helped create and maintain this package.
Contributors are listed at thecontributorssection.
Package: djangocms-aldryn-people
Aldryn People for django CMSContinuation of the deprecated projectDivio Aldryn search.Aldryn People allows you to:add people and groups of people to your websitedisplay them on CMS pagesdownload vCardsPlease see theAldryn People documentation,
which includes information on installation and getting started.It also containsdocumentation for content editors and end-users.ContributingAldryn People is a an open-source project. We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your pull
request, please review ourguidelines for Aldryn Addons.We’re grateful to all contributors who have helped create and maintain this package.Contributors are listed atcontributions page.
Package: djangocms-algolia
Allows to easily index CMS pages and push them to algolia.UsageInstall aspip install djangocms-algolia.Add the following variables to settings.py:INSTALLED_APPS=['djangocms_algolia','algoliasearch_django',]ALGOLIA={'APPLICATION_ID':env.get('ALGOLIA_APPLICATION_ID',''),'API_KEY':env.get('ALGOLIA_API_KEY','')}# not used, but django-haystack requires it to be preset in settings.pyHAYSTACK_CONNECTIONS={'default':{'ENGINE':'haystack.backends.simple_backend.SimpleEngine'}}You can exclude plugins from indexing by adding them tosettings.ALDRYN_SEARCH_EXCLUDED_PLUGINS.You can also limit the CMS pages content usingsettings.ALGOLIA_SEARCH_INDEX_TEXT_LIMIT.Render plain text from CMS placeholdersThis package also includes a function that helps to index django models which utilizePlaceholderField.You can use it as following:fromdjangocms_algolia.utils.renderimportrender_text_from_placeholderclassCustomModel(Model):placeholder=PlaceholderField('Content')defdescription(self)->str:returnrender_text_from_placeholder(self.placeholder)
Package: djangocms-alias
django CMS Alias replicates and extends the alias function of django CMS version 3 for django CMS version 4.An alias is a collection of plugins that is managed centrally. A reference can be added to any placeholder using the Alias plugin. Since the Alias plugin creates a reference any changes to the alias are immediately reflected at all places it is used.django CMS Alias supports versioning aliases by django CMS Versioning.WarningThis is the development branch for django CMS version 4.1 support.For django CMS V4.0 support, seesupport/django-cms-4.0.x branchInstallationRequirementsdjango CMS Alias requires that you have a django CMS 4 (or higher) project already running and set up.To installRun:pip install git+https://github.com/django-cms/djangocms-alias@master#egg=djangocms-aliasAdddjangocms_aliasandparlerto your project’sINSTALLED_APPS.Run:python manage.py migrate djangocms_aliasto perform the application’s database migrations.UsageStatic aliasesStatic aliases appear in templates and replace static placeholders which were part of django CMS up to version 3.x.Example:{% load djangocms_alias_tags %}
...
<footer>
  {% static_alias 'footer' %}
</footer>Alias pluginAlternatively, aliases can be used with the Alias plugin. It allows to select which alias content is shown at the exact position the alias plugin is placed.
Package: djangocms-angular-compendium
djangocms-angular-compendium============================A collection of templates to be used for overriding existing templates from various DjangoCMSplugins, when running with the AngularJS framework.Currently these templates are overridden:* ``cmsplugin_filer_image/image.html``: Replace tag ``<img src="...">`` against ``<img ng-src="...">``.This is required by the AngularJS [ngSrc](http://docs.angularjs.org/api/ng.directive:ngSrc)directive.* ``cms/plugins/bootstrap/carousel.html`` and ``carousel-slide.html``: Replace the Carousel HTMLcode with a variant running with the [Angular UI Bootstrap](http://angular-ui.github.io/bootstrap/#/carousel)library.Installation and configuration------------From PyPI::pip install djangocms-angular-compendiumIn your project's settings, add ``angularjs_compendium`` to ``INSTALLED_APPS``. Check that thisentry is located before any DjangoCMS plugin entry::INSTALLED_APPS = (...'angularjs_compendium',...other DjangoCMS plugins...)License-------Released under the terms of MIT License.Copyright (C) 2013, Jacob Rief <jacob.rief@gmail.com>
Package: djangocms-animate-on-scroll
Django Animate on ScrollAn extension for Django CMS that adds the aos library to animate elements on your page as you scroll.InstallationInstall with pippip install djangocms-animate-on-scrollAdddjangocms_animate_on_scrollto INSTALLED_APPSRun migrationspython manage.py migrateUsageAfter installation simply add the plugins to the page.
Package: django-cms-articles
django-cms-articlesthe best django CMS application for managing articlesThis application provides full featured articles management for django CMS.
It is heavily inspired by (and partially copied from) the page management in django CMS itself.Featuresintuitive admin UI inspired by django CMS page UIintuitive front-end editing using placeholders and toolbar menusupports multiple languages (the same way as django CMS does)publisher workflow from django CMSflexible plugins to render article outside django CMS pageInstallation and usageInstallation and usage is quite traightforward.install (using pip) django-cms-articlesadd "cms_articles" into your settings.INSTALLED_APPScheck cms_articles.conf.default_settings for values you may want to override in your settingsadd "Articles Category" apphook to any django CMS page, which should act as category for articlesadd "Articles" plugin to placeholder of your choice to show articles belonging to that page / categoryBugs and Feature requestsShould you encounter any bug or have some feature request,
create an issue athttps://github.com/misli/django-cms-articles/issues.
Package: djangocms-audio
django CMS Audiois a set of plugins fordjango CMSthat allow you to publish audio files on your site (using an HTML5 player by default,
but you can override this in your own templates if required).It uses files managed byDjango Filer.
The plugins allow you to select a single file or an entire folder of files.NoteThis project is considered 3rd party (no supervision by thedjango CMS Association). Join us onSlackfor more information.Contribute to this project and win rewardsBecause this is a an open-source project, we welcome everyone toget involved in the projectandreceive a rewardfor their contribution.
Become part of a fantastic community and help us make django CMS the best CMS in the world.We’ll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review ourcontribution guidelines.We’re grateful to all contributors who have helped create and maintain this package.
Contributors are listed at thecontributorssection.DocumentationSeeREQUIREMENTSin thesetup.pyfile for additional dependencies:Django Filer 1.7 or higherMake suredjango-fileris installed and configured appropriately.InstallationFor a manual install:runpip installdjangocms-audioadddjangocms_audioto yourINSTALLED_APPSrunpython manage.py migrate djangocms_audioConfigurationNote that the provided templates are very minimal by design. You are encouraged
to adapt and override them to your project’s requirements.This addon provides adefaulttemplate for all instances. You can provide
additional template choices by adding aDJANGOCMS_AUDIO_TEMPLATESsetting:DJANGOCMS_AUDIO_TEMPLATES = [
    ('feature', _('Featured Version')),
]You’ll need to create thefeaturefolder insidetemplates/djangocms_audio/otherwise you will get atemplate does not existerror. You can do this by
copying thedefaultfolder inside that directory and renaming it tofeature.MP3andOGGfiles are allowed by default. We recommend usingMP3as it’s supported across all major browsers. You can change the default
setting by overriding:DJANGOCMS_AUDIO_ALLOWED_EXTENSIONS = ['mp3', 'ogg', 'wav']Running TestsYou can run tests by executing:virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test
Package: django_cms_auth_apphook
Django CMS Auth Apphook=======================App hook to make integration with the standard Django Auth Library (`django.contrib.auth`) easier. Also includes templates for all auth views.Installation------------To install, you will need to clone the git, then run the setup.py script:git clone https://github.com/flungo/django_cms_auth_apphook.gitcd django_cms_auth_apphookpython setup.py installConfiguration-------------Add `auth_apphook` to your list of `INSTALLED_APPS`. It's position doesn't matter unless you have `django.contrib.admin` installed (which to be honest, you probably do) and you want to use the included templates. `django.contrib.admin` contains several templates for `django.contrib.auth` so in order to use the included templates (see bellow) you should make sure it is listed before `django.contrib.admin`.INSTALLED_APPS = (# ...'auth_apphook',# ...'django.contrib.auth',# ...)Templates---------------------Included with this app are the core templates required by the front end to generate the appropriate pages. I have made them all extend "base.html" so they will by default have your theme but should you need to customise these, you can copy the `registration` directory to your templates directory and customise till your heart's content.