eea.stringinterp 1.2__tar.gz

eea_stringinterp-1.2/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# How to contribute
+
+To start, is important to mention that we keep all EEA pacakges under EEA Organisation
+on GitHub (https://github.com/eea) and we fork them to Collective so everyone can
+contribute to them. We keep the repositories from Collective and EEA in sync.
+
+We want to keep it as easy as possible to contribute changes that
+get things working. There are a few guidelines that we
+need contributors to follow so that we can have a chance of keeping on
+top of things.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* If you need to submit a ticket do it under EEA Organisation area (https://github.com/eea)
+  under the respective package, e.g. https://github.com/eea/eea.stringinterp/issues
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * If case state the browser and operating system used.
+* We also keep a discussion lists for most of the public packages under Google Groups.
+
+Please note that adding a bug report or feature request in the EEA github does not
+automatically mean that EEA will work on them, since there are budget implications.
+
+The issues/features registered in github are regarded only as community requests and
+here to facilitate the Plone community contributions.
+
+EEA will work directly on the Plone community's requests when they coincide with
+EEA's planned projects. In this case we will transfer the ticket to the EEA
+official issue register.
+
+## Making Changes
+
+* Fork the repository from EEA or directly commit within Collective fork
+* Make sure you added an entry under HISTORY.txt describing your changes
+* Make sure you have added the necessary tests for your changes (do not forget major browsers).
+* Make sure you have updated and added documentation when necessary.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Push your changes in your fork of the repository.
+* Submit a pull request to the upstream repository (EEA).
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [EEA packages](https://eea.github.io/docs/IT-systems/)

eea_stringinterp-1.2/MANIFEST.in

@@ -0,0 +1,8 @@
+include *.md *.rst *.txt
+graft docs
+graft eea
+global-exclude *pyc
+global-exclude *~
+global-exclude *.un~
+
+global-include *.mo

eea_stringinterp-1.2/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: eea.stringinterp
+Version: 1.2
+Summary: Extended plone.stringinterp functionality
+Home-page: https://github.com/eea/eea.stringinterp
+Author: European Environment Agency: IDM2 A-Team
+Author-email: eea-edw-a-team-alerts@googlegroups.com
+License: GPL version 2
+Keywords: EEA Add-ons Plone Zope
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Plone
+Classifier: Framework :: Plone :: Addon
+Classifier: Framework :: Plone :: 5.2
+Classifier: Framework :: Plone :: 6.0
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Description-Content-Type: text/x-rst
+Requires-Dist: setuptools
+Provides-Extra: test
+Requires-Dist: plone.app.testing; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+==========================
+eea.stringinterp
+==========================
+.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.stringinterp/develop
+  :target: https://ci.eionet.europa.eu/job/eea/job/eea.stringinterp/job/develop/display/redirect
+  :alt: Develop
+.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.stringinterp/master
+  :target: https://ci.eionet.europa.eu/job/eea/job/eea.stringinterp/job/master/display/redirect
+  :alt: Master
+
+Extends `plone.stringinterp <https://github.com/plone/plone.stringinterp>`_ functionallity with a 
+generic fallback string substitution adapter that lookup **context** properties if no explicit named
+**IStringSubstitution** is defined.
+
+.. contents::
+
+Main features
+=============
+
+1. **Generic string substitution** adapter to easily grab custom properties from context
+
+Install
+=======
+
+* Add eea.stringinterp to your eggs section in your buildout and
+  re-run buildout::
+
+    [buildout]
+    eggs +=
+      eea.stringinterp
+
+* You can download a sample buildout from:
+
+  - https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone4
+  - https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone5
+
+* Or via docker::
+
+    $ docker run --rm -p 8080:8080 -e ADDONS="eea.stringinterp" plone
+
+* Install *eea.stringinterp* within Site Setup > Add-ons
+
+
+Usage
+=====
+
+* Via **Site Setup > Dexterity Content Types > Page > Fields Tab** add new Field, `e.g.: custom_field`
+* Via **Site Setup > Content Rules** add a rule to send email on Workflow change
+* Within **Message** add some `Custom: ${custom_field}`
+* Add new **Page** and fill the **custom_field**
+* Publish your **Page**
+* Check your email
+
+Code usage
+==========
+
+    >>> from plone.stringinterp.interfaces import IStringSubstitution
+    >>> substitute = IStringSubstitution(sandbox)
+    >>> substitute
+    <eea.stringinterp.adapters.GenericContextAttributeSubstitution object at...>
+
+    >>> substitute('title')
+    'Sandbox'
+
+    >>> substitute('effective')
+    'Oct 10, 2021 12:00 AM'
+
+    >>> substitute('Subject')
+    'air, pollution'
+
+
+Buildout installation
+=====================
+
+- `Plone 4+ <https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone4>`_
+- `Plone 5+ <https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone5>`_
+
+
+Source code
+===========
+
+- `Plone 4+ on github <https://github.com/eea/eea.stringinterp>`_
+- `Plone 5+ on github <https://github.com/eea/eea.stringinterp>`_
+
+
+Eggs repository
+===============
+
+- https://pypi.python.org/pypi/eea.stringinterp
+- http://eggrepo.eea.europa.eu/simple
+
+
+Plone versions
+==============
+It has been developed and tested for Plone 4 and 5. See buildouts section above.
+
+
+How to contribute
+=================
+See the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.stringinterp/blob/master/CONTRIBUTING.md>`_.
+
+Copyright and license
+=====================
+
+eea.stringinterp (the Original Code) is free software; you can
+redistribute it and/or modify it under the terms of the
+GNU General Public License as published by the Free Software Foundation;
+either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc., 59
+Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+Portions created by Eau de Web are Copyright (C) 2009 by
+European Environment Agency. All Rights Reserved.
+
+
+Funding
+=======
+
+EEA_ - European Environment Agency (EU)
+
+.. _EEA: https://www.eea.europa.eu/
+.. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1
+
+Changelog
+=========
+
+1.2 - (2025-11-18)
+---------------------------
+* Change: Replace Python linting to ruff
+  [mihaidobrescu1111 = refs #286821]
+* Change: Add plone6 tests
+  [mihaidobrescu1111 = refs #293593]
+
+1.1 - (2023-08-31)
+---------------------------
+* remove python_requires from setup.py
+  [valipod - refs #161113]
+
+1.0 - (2021-05-28)
+-----------------------
+
+* Add 'Generic string substitution' adapter to easily grab properties from context
+  [avoinea - refs #134513]

eea_stringinterp-1.2/README.rst

@@ -0,0 +1,130 @@
+==========================
+eea.stringinterp
+==========================
+.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.stringinterp/develop
+  :target: https://ci.eionet.europa.eu/job/eea/job/eea.stringinterp/job/develop/display/redirect
+  :alt: Develop
+.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.stringinterp/master
+  :target: https://ci.eionet.europa.eu/job/eea/job/eea.stringinterp/job/master/display/redirect
+  :alt: Master
+
+Extends `plone.stringinterp <https://github.com/plone/plone.stringinterp>`_ functionallity with a 
+generic fallback string substitution adapter that lookup **context** properties if no explicit named
+**IStringSubstitution** is defined.
+
+.. contents::
+
+Main features
+=============
+
+1. **Generic string substitution** adapter to easily grab custom properties from context
+
+Install
+=======
+
+* Add eea.stringinterp to your eggs section in your buildout and
+  re-run buildout::
+
+    [buildout]
+    eggs +=
+      eea.stringinterp
+
+* You can download a sample buildout from:
+
+  - https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone4
+  - https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone5
+
+* Or via docker::
+
+    $ docker run --rm -p 8080:8080 -e ADDONS="eea.stringinterp" plone
+
+* Install *eea.stringinterp* within Site Setup > Add-ons
+
+
+Usage
+=====
+
+* Via **Site Setup > Dexterity Content Types > Page > Fields Tab** add new Field, `e.g.: custom_field`
+* Via **Site Setup > Content Rules** add a rule to send email on Workflow change
+* Within **Message** add some `Custom: ${custom_field}`
+* Add new **Page** and fill the **custom_field**
+* Publish your **Page**
+* Check your email
+
+Code usage
+==========
+
+    >>> from plone.stringinterp.interfaces import IStringSubstitution
+    >>> substitute = IStringSubstitution(sandbox)
+    >>> substitute
+    <eea.stringinterp.adapters.GenericContextAttributeSubstitution object at...>
+
+    >>> substitute('title')
+    'Sandbox'
+
+    >>> substitute('effective')
+    'Oct 10, 2021 12:00 AM'
+
+    >>> substitute('Subject')
+    'air, pollution'
+
+
+Buildout installation
+=====================
+
+- `Plone 4+ <https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone4>`_
+- `Plone 5+ <https://github.com/eea/eea.stringinterp/tree/master/buildouts/plone5>`_
+
+
+Source code
+===========
+
+- `Plone 4+ on github <https://github.com/eea/eea.stringinterp>`_
+- `Plone 5+ on github <https://github.com/eea/eea.stringinterp>`_
+
+
+Eggs repository
+===============
+
+- https://pypi.python.org/pypi/eea.stringinterp
+- http://eggrepo.eea.europa.eu/simple
+
+
+Plone versions
+==============
+It has been developed and tested for Plone 4 and 5. See buildouts section above.
+
+
+How to contribute
+=================
+See the `contribution guidelines (CONTRIBUTING.md) <https://github.com/eea/eea.stringinterp/blob/master/CONTRIBUTING.md>`_.
+
+Copyright and license
+=====================
+
+eea.stringinterp (the Original Code) is free software; you can
+redistribute it and/or modify it under the terms of the
+GNU General Public License as published by the Free Software Foundation;
+either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc., 59
+Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+Portions created by Eau de Web are Copyright (C) 2009 by
+European Environment Agency. All Rights Reserved.
+
+
+Funding
+=======
+
+EEA_ - European Environment Agency (EU)
+
+.. _EEA: https://www.eea.europa.eu/
+.. _`EEA Web Systems Training`: http://www.youtube.com/user/eeacms/videos?view=1

eea_stringinterp-1.2/docs/HISTORY.txt

@@ -0,0 +1,20 @@
+Changelog
+=========
+
+1.2 - (2025-11-18)
+---------------------------
+* Change: Replace Python linting to ruff
+  [mihaidobrescu1111 = refs #286821]
+* Change: Add plone6 tests
+  [mihaidobrescu1111 = refs #293593]
+
+1.1 - (2023-08-31)
+---------------------------
+* remove python_requires from setup.py
+  [valipod - refs #161113]
+
+1.0 - (2021-05-28)
+-----------------------
+
+* Add 'Generic string substitution' adapter to easily grab properties from context
+  [avoinea - refs #134513]