.. image:: https://travis-ci.com/codesyntax/bobtemplates.cs.svg?branch=master
:target: http://travis-ci.com/codesyntax/bobtemplates.cs
.. image:: https://coveralls.io/repos/github/codesyntax/bobtemplates.cs/badge.svg?branch=master
:target: https://coveralls.io/github/codesyntax/bobtemplates.cs?branch=master
:alt: Coveralls
.. image:: https://img.shields.io/pypi/v/bobtemplates.cs.svg
:target: https://pypi.python.org/pypi/bobtemplates.cs/
:alt: Latest Version
.. image:: https://readthedocs.org/projects/bobtemplatescs/badge/?version=latest
:target: https://bobtemplatescs.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/bobtemplates.cs.svg
:target: https://pypi.python.org/pypi/bobtemplates.cs/
:alt: License
================
bobtemplates.cs
================
`bobtemplates.cs` provides a `mr.bob <http://mrbob.readthedocs.org/en/latest/>`_ template to generate packages for Plone projects using our customizations. This packages is based on `bobtemplates.plone <https://pypi.python.org/project/bobtemplates.plone>`_
Features
========
Package created with ``bobtemplates.cs`` use the current best-practices when creating an add-on.
Provided templates
------------------
- cs_plone_volto_buildout
- cs_plone_buildout
- cs_migration
cs_plone_volto_buildout
~~~~~~~~~~~~~~~~~~~~~~~
This template provides a ready-to-use buildout template for Plone backends for Volto. It asks for a Plone version
and configures the buildout with it.
The generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.
It also creates cron jobs to pack your database and to restart the services when the server is rebooted.
cs_plone_buildout
~~~~~~~~~~~~~~~~~
This template provides a ready-to-use buildout template for Plone sites. It asks for a Plone version
and configures the buildout with it.
The generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.
It also creates cron jobs to pack your database and to restart the services when the server is rebooted.
cs_migration
~~~~~~~~~~~~
This template adds some useful blueprints and a pipeline for a `Transmogrifier`_ based migration for Plone 5.
The provided pipeline will work with a
`collective.jsonify <https://pypi.org/project/collective.jsonify/>`_ export out of the box.
We have been using the blueprints and the pipeline in several projects and found them very useful. To make the pipeline work correctly, you will need to adjust the created migration1.cfg file to provide the path of the export and adjust one or two parameters.
To get started with Transmogrifier, visit the training at https://training.plone.org/5/transmogrifier
You can run the migration from the command line, using the provided zopectl scripts, as follows. Inspect all the registered transmogrifier pipelines::
$ cd /path/to/your/buildout
$ ./bin/instance list_migrations
Run the selected pipeline::
$ cd /path/to/your/buildout
$ ./bin/instance run_migration my.package-step1
Compatibility
=============
Add-ons created with ``bobtemplates.cs`` are tested to work in Plone 5 and Plone 5.1.
They should also work with older versions but that was not tested.
It should work on Linux, Mac and Windows.
Documentation
=============
Full documentation for end users can be found in the "docs" folder.
Contribute
==========
- Issue Tracker: https://github.com/codesyntax/bobtemplates.cs/issues
- Source Code: https://github.com/codesyntax/bobtemplates.cs
- Documentation:
Support
=======
If you are having issues, please let us know.
.. _`Transmogrifier`: https://pypi.org/projects/collective.transmogrifier
Changelog
=========
1.9.1 (2024-02-13)
------------------
- Repackage [erral]
1.8 (2024-02-13)
----------------
- Add OIDC plugin configuration [erral]
- Add ZEO egg in the ZEO part [erral]
- Add vscode recipe [erral]
1.7 (2023-04-05)
----------------
- Update versions to Plone 6 [erral]
1.6 (2022-09-22)
----------------
- update logrotate path [Mikel Larreategi <mlarreategi@codesyntax.com>]
- set default Plone version to 5.2.9 [Mikel Larreategi <mlarreategi@codesyntax.com>]
- set default security policies in nginx [Mikel Larreategi <mlarreategi@codesyntax.com>]
- Update nginx_ssl_http2.tpl [Mikel Larreategi <mlarreategi@codesyntax.com>]
- Update nginx_ssl_http2.tpl [Mikel Larreategi <mlarreategi@codesyntax.com>]
- [Mikel Larreategi <mlarreategi@codesyntax.com>]
- [ci skip] [Mikel Larreategi <mlarreategi@codesyntax.com>]
1.5 (2022-04-06)
----------------
- New Volto backend template
[ionlizarazu]
1.4.1 (2021-10-22)
------------------
- change the section that eggs come from: Zope2 and Plone are define in instance, so they should come from there [Mikel Larreategi <mlarreategi@codesyntax.com>]
- [Mikel Larreategi <mlarreategi@codesyntax.com>]
- [ci skip] [Mikel Larreategi <mlarreategi@codesyntax.com>]
1.4 (2021-10-21)
----------------
- add egg option to the zeo part, to be able to do conflict-resolution [Mikel Larreategi <mlarreategi@codesyntax.com>]
- [Mikel Larreategi <mlarreategi@codesyntax.com>]
- [ci skip] [Mikel Larreategi <mlarreategi@codesyntax.com>]
1.3.1 (2021-08-31)
------------------
- Fix user import blueprint (fullname)
[erral]
1.3 (2021-08-30)
----------------
- User migration blueprint and new version pins
[erral]
- update version pins
[erral]
1.2.4 (2020-10-16)
------------------
- Default to Plone 5.2.2
[erral]
- Update version pins.
[erral]
1.2.3 (2020-02-19)
------------------
- Update haproxy
[erral]
- Use new Travis.
[erral]
1.2.2 (2020-01-21)
------------------
- Use `+=` in buildout part eggs link to make hotfix installation from external versions file work
[erral]
- Update supervisor version pins.
[erral]
1.2.1 (2019-05-15)
------------------
- Remove 'products' directory registration for buildout recipe
[erral]
- update varnish control script in supervisor.
[erral]
1.2 (2019-04-04)
----------------
- Always cache Diazo rules in development
[erral]
- Enable WSGI
[erral]
- Update pinnings
[erral]
- Remove checkinterval calculation.
- Python3 compatibility fixes
[erral]
1.1.4 (2019-01-24)
------------------
- Fix template registration
[erral]
1.1.3 (2019-01-24)
------------------
- Minor fixes in template registration.
[erral]
1.1.2 (2019-01-16)
------------------
- Bugfixes in migration subtemplate.
[erral]
1.1.1 (2018-11-26)
------------------
- Minor fix.
[erral]
1.1 (2018-11-26)
----------------
- Add a subtemplate with migration utils.
[erral]
1.0.0 (2018-10-19)
------------------
- Link to starzel buildout for hotfix installation
[erral]
- Improve docs
[erral]
- More tests
[erral]
1.0b1 (2018-10-18)
------------------
- No changes yet.
Raw data
{
"_id": null,
"home_page": "https://github.com/codesyntax/bobtemplates.cs",
"name": "bobtemplates.cs",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "web plone zope skeleton project",
"author": "Mikel Larreategi",
"author_email": "mlarreategi@codesyntax.com",
"download_url": "https://files.pythonhosted.org/packages/cf/5a/d042b223c7c1d1c173202cb33488171fc065ef528bba6efa2a9081330127/bobtemplates.cs-1.9.1.tar.gz",
"platform": null,
"description": "\n.. image:: https://travis-ci.com/codesyntax/bobtemplates.cs.svg?branch=master\n :target: http://travis-ci.com/codesyntax/bobtemplates.cs\n\n.. image:: https://coveralls.io/repos/github/codesyntax/bobtemplates.cs/badge.svg?branch=master\n :target: https://coveralls.io/github/codesyntax/bobtemplates.cs?branch=master\n :alt: Coveralls\n\n.. image:: https://img.shields.io/pypi/v/bobtemplates.cs.svg\n :target: https://pypi.python.org/pypi/bobtemplates.cs/\n :alt: Latest Version\n\n.. image:: https://readthedocs.org/projects/bobtemplatescs/badge/?version=latest\n :target: https://bobtemplatescs.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/l/bobtemplates.cs.svg\n :target: https://pypi.python.org/pypi/bobtemplates.cs/\n :alt: License\n\n================\nbobtemplates.cs\n================\n\n`bobtemplates.cs` provides a `mr.bob <http://mrbob.readthedocs.org/en/latest/>`_ template to generate packages for Plone projects using our customizations. This packages is based on `bobtemplates.plone <https://pypi.python.org/project/bobtemplates.plone>`_\n\n\nFeatures\n========\n\nPackage created with ``bobtemplates.cs`` use the current best-practices when creating an add-on.\n\nProvided templates\n------------------\n\n- cs_plone_volto_buildout\n- cs_plone_buildout\n- cs_migration\n\ncs_plone_volto_buildout\n~~~~~~~~~~~~~~~~~~~~~~~\n\nThis template provides a ready-to-use buildout template for Plone backends for Volto. It asks for a Plone version\nand configures the buildout with it.\n\nThe generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.\n\nIt also creates cron jobs to pack your database and to restart the services when the server is rebooted.\n\ncs_plone_buildout\n~~~~~~~~~~~~~~~~~\n\nThis template provides a ready-to-use buildout template for Plone sites. It asks for a Plone version\nand configures the buildout with it.\n\nThe generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.\n\nIt also creates cron jobs to pack your database and to restart the services when the server is rebooted.\n\n\ncs_migration\n~~~~~~~~~~~~\n\nThis template adds some useful blueprints and a pipeline for a `Transmogrifier`_ based migration for Plone 5.\n\nThe provided pipeline will work with a\n`collective.jsonify <https://pypi.org/project/collective.jsonify/>`_ export out of the box.\n\nWe have been using the blueprints and the pipeline in several projects and found them very useful. To make the pipeline work correctly, you will need to adjust the created migration1.cfg file to provide the path of the export and adjust one or two parameters.\n\nTo get started with Transmogrifier, visit the training at https://training.plone.org/5/transmogrifier\n\nYou can run the migration from the command line, using the provided zopectl scripts, as follows. Inspect all the registered transmogrifier pipelines::\n\n $ cd /path/to/your/buildout\n $ ./bin/instance list_migrations\n\n\nRun the selected pipeline::\n\n $ cd /path/to/your/buildout\n $ ./bin/instance run_migration my.package-step1\n\n\n\n\nCompatibility\n=============\n\nAdd-ons created with ``bobtemplates.cs`` are tested to work in Plone 5 and Plone 5.1.\nThey should also work with older versions but that was not tested.\nIt should work on Linux, Mac and Windows.\n\n\nDocumentation\n=============\n\nFull documentation for end users can be found in the \"docs\" folder.\n\n\nContribute\n==========\n\n- Issue Tracker: https://github.com/codesyntax/bobtemplates.cs/issues\n- Source Code: https://github.com/codesyntax/bobtemplates.cs\n- Documentation:\n\n\nSupport\n=======\n\nIf you are having issues, please let us know.\n\n.. _`Transmogrifier`: https://pypi.org/projects/collective.transmogrifier\n\n\nChangelog\n=========\n\n1.9.1 (2024-02-13)\n------------------\n\n- Repackage [erral]\n\n1.8 (2024-02-13)\n----------------\n\n- Add OIDC plugin configuration [erral]\n\n- Add ZEO egg in the ZEO part [erral]\n\n- Add vscode recipe [erral]\n\n\n1.7 (2023-04-05)\n----------------\n\n- Update versions to Plone 6 [erral]\n\n\n1.6 (2022-09-22)\n----------------\n\n- update logrotate path [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- set default Plone version to 5.2.9 [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- set default security policies in nginx [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- Update nginx_ssl_http2.tpl [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- Update nginx_ssl_http2.tpl [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- [ci skip] [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n\n\n1.5 (2022-04-06)\n----------------\n\n- New Volto backend template\n [ionlizarazu]\n\n\n1.4.1 (2021-10-22)\n------------------\n\n- change the section that eggs come from: Zope2 and Plone are define in instance, so they should come from there [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- [ci skip] [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n\n\n1.4 (2021-10-21)\n----------------\n\n- add egg option to the zeo part, to be able to do conflict-resolution [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n- [ci skip] [Mikel Larreategi <mlarreategi@codesyntax.com>]\n\n\n\n1.3.1 (2021-08-31)\n------------------\n\n- Fix user import blueprint (fullname)\n [erral]\n\n\n1.3 (2021-08-30)\n----------------\n\n- User migration blueprint and new version pins\n [erral]\n\n- update version pins\n [erral]\n\n\n1.2.4 (2020-10-16)\n------------------\n\n- Default to Plone 5.2.2\n [erral]\n\n- Update version pins.\n [erral]\n\n\n1.2.3 (2020-02-19)\n------------------\n\n- Update haproxy\n [erral]\n\n- Use new Travis.\n [erral]\n\n\n1.2.2 (2020-01-21)\n------------------\n\n- Use `+=` in buildout part eggs link to make hotfix installation from external versions file work\n [erral]\n\n- Update supervisor version pins.\n [erral]\n\n\n1.2.1 (2019-05-15)\n------------------\n\n- Remove 'products' directory registration for buildout recipe\n [erral]\n\n- update varnish control script in supervisor.\n [erral]\n\n\n1.2 (2019-04-04)\n----------------\n\n- Always cache Diazo rules in development\n [erral]\n\n- Enable WSGI\n [erral]\n\n- Update pinnings\n [erral]\n\n- Remove checkinterval calculation.\n- Python3 compatibility fixes\n [erral]\n\n\n1.1.4 (2019-01-24)\n------------------\n\n- Fix template registration\n [erral]\n\n\n1.1.3 (2019-01-24)\n------------------\n\n- Minor fixes in template registration.\n [erral]\n\n\n1.1.2 (2019-01-16)\n------------------\n\n- Bugfixes in migration subtemplate.\n [erral]\n\n\n1.1.1 (2018-11-26)\n------------------\n\n- Minor fix.\n [erral]\n\n1.1 (2018-11-26)\n----------------\n\n- Add a subtemplate with migration utils.\n [erral]\n\n\n1.0.0 (2018-10-19)\n------------------\n\n- Link to starzel buildout for hotfix installation\n [erral]\n\n- Improve docs\n [erral]\n\n- More tests\n [erral]\n\n1.0b1 (2018-10-18)\n------------------\n\n- No changes yet.\n",
"bugtrack_url": null,
"license": "GPLv2",
"summary": "Templates for Plone projects by CodeSyntax",
"version": "1.9.1",
"project_urls": {
"Homepage": "https://github.com/codesyntax/bobtemplates.cs"
},
"split_keywords": [
"web",
"plone",
"zope",
"skeleton",
"project"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf5ad042b223c7c1d1c173202cb33488171fc065ef528bba6efa2a9081330127",
"md5": "a277018a5aead71089550df8d733a8b2",
"sha256": "64fe835c4d00d9e588c49daae3b6c1367e51d717e09976c041c6102b79f6fabf"
},
"downloads": -1,
"filename": "bobtemplates.cs-1.9.1.tar.gz",
"has_sig": false,
"md5_digest": "a277018a5aead71089550df8d733a8b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 55351,
"upload_time": "2024-02-13T12:03:55",
"upload_time_iso_8601": "2024-02-13T12:03:55.903089Z",
"url": "https://files.pythonhosted.org/packages/cf/5a/d042b223c7c1d1c173202cb33488171fc065ef528bba6efa2a9081330127/bobtemplates.cs-1.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 12:03:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codesyntax",
"github_project": "bobtemplates.cs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "bobtemplates.cs"
}
JSON
