.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on pypi or github. It is a comment.
.. image:: https://github.com/IMIO/imio.directory.core/workflows/Tests/badge.svg
:target: https://github.com/IMIO/imio.directory.core/actions?query=workflow%3ATests
:alt: CI Status
.. image:: https://coveralls.io/repos/github/IMIO/imio.directory.core/badge.svg?branch=main
:target: https://coveralls.io/github/IMIO/imio.directory.core?branch=main
:alt: Coveralls
.. image:: https://img.shields.io/pypi/v/imio.directory.core.svg
:target: https://pypi.python.org/pypi/imio.directory.core/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/status/imio.directory.core.svg
:target: https://pypi.python.org/pypi/imio.directory.core
:alt: Egg Status
.. image:: https://img.shields.io/pypi/pyversions/imio.directory.core.svg?style=plastic :alt: Supported - Python Versions
.. image:: https://img.shields.io/pypi/l/imio.directory.core.svg
:target: https://pypi.python.org/pypi/imio.directory.core/
:alt: License
===================
imio.directory.core
===================
Directory product for 'Contacts authentic source' website
Features
--------
This products contains two content types: Entity & Contact.
An entity is bound to one or more belgian zip codes and contains editable geolocated contacts.
A contact can be exported to a vcard file using an object action.
This directory product is made to be used only by editors, to build the authentic source.
The website is then queried (RESTAPI) from other iMio websites.
Contacts are displayed in those sites by `imio.smartweb.core <https://github.com/IMIO/imio.smartweb.core>`_ contact section.
Examples
--------
- https://annuaire.enwallonie.be
Documentation
-------------
Contact can be import from a CSV file via an action on the right Entity.
CSV Delimiter is ";"? and columns must be :
================ ============================================================
Column Index Data
================ ============================================================
00 contact type
01 title
02 subtitle
03 description
04 street
05 number
06 complement
07 zipcode
08 city
09 country
10 vat number
11 latitude
12 longitude
13 phone label 1
14 phone type 1
15 phone number 1
16 phone label 2
17 phone type 2
18 phone number 2
19 phone label 3
20 phone type 3
21 phone number 3
22 mail label 1
23 mail type 1
24 mail address 1
25 mail label 2
26 mail type 2
27 mail address 2
28 mail label 3
29 mail type 3
30 mail address 3
31 url type 1
32 url link 1
33 url type 2
34 url link 2
35 url type 3
36 url link 3
37 topic 1
38 topic 2
39 topic 3
40 category 1
41 category 2
42 category 3
43 facility 1
44 facility 2
45 facility 3
46 iam 1
47 iam 2
48 iam 3
================ ============================================================
Translations
------------
This product has been translated into
- French
The translation domain is ``imio.smartweb`` and the translations are stored in `imio.smartweb.locales <https://github.com/IMIO/imio.smartweb.locales>`_ package.
Installation
------------
Install imio.directory.core by adding it to your buildout::
[buildout]
...
eggs =
imio.directory.core
and then running ``bin/buildout``
Contribute
----------
- Issue Tracker: https://github.com/collective/imio.directory.core/issues
- Source Code: https://github.com/collective/imio.directory.core
License
-------
The project is licensed under the GPLv2.
Contributors
============
- Christophe Boulanger, christophe.boulanger@imio.be
- Laurent Lasudry, laurent.lasudry@affinitic.be
Changelog
=========
1.2.10 (2024-04-10)
-------------------
- WEB-4095 : Use "|" separator instead of "," when exporting contacts to csv file
[boulch]
1.2.9 (2024-02-27)
------------------
- WEB-4072, WEB-4073 : Enable solr.fields behavior on some content types
[remdub]
- WEB-4006 : Exclude some content types from search results
[remdub]
1.2.8 (2024-02-12)
------------------
- MWEBRCHA-14 : Add view to export contacts to csv file
[boulch]
1.2.7 (2024-02-02)
------------------
- SUP-34841 : Fix contact serializer when contact hasn't schedule
[boulch]
1.2.6 (2024-01-31)
------------------
- WEB-4006 : Also reindex solr on SearchableText upgrade step
[remdub]
1.2.5 (2024-01-31)
------------------
- WEB-4006 : Add mail and phone labels in SearchableText
[remdub]
1.2.4 (2024-01-17)
------------------
- WEB-4052 : If all values in schedule are "" then we set "table_date" to None
[boulch]
1.2.3 (2024-01-09)
------------------
- WEB-4041 : Handle new "carre" scale
[boulch]
- WEB-4007 : Update contact serializer and use ContactProperties to get well formated schedule
and help displaying schedule in REACT directory view
[boulch]
1.2.2 (2023-11-20)
------------------
- WEB-4018 : Add three new terms in facitilites vocabulary
[boulch]
- Fix missing values for topics / iam lists (causing `None` in REST views filters)
See https://github.com/collective/collective.solr/issues/366
[laulaz]
1.2.1 (2023-10-26)
------------------
- Remove logo field from cropping editor
[laulaz]
1.2 (2023-10-25)
----------------
- WEB-3985 : Use new portrait / paysage scales & logic
[boulch, laulaz]
- WEB-3985 : Remove old cropping information when image changes
[boulch, laulaz]
1.1.11 (2023-10-25)
-------------------
- MWEBITTA-21 : Add entities subscribing to share all contacts
[boulch, laulaz]
1.1.10 (2023-10-09)
-------------------
- WEB-3918 : Add missing DE translations for contact_category taxonomy
[laulaz]
- Update contact_category taxonomy data to reflect production site data
[laulaz]
1.1.9 (2023-05-26)
------------------
- Fix condition when facing `Missing.Value` to avoid traceback in serializer
[laulaz]
- WEB-3918 : Add missing DE translations for contact_category taxonomy
[laulaz]
- Migrate to Plone 6.0.4
[boulch]
- Update contact_category taxonomy data to reflect production site data
[laulaz]
1.1.8 (2023-03-31)
------------------
- WEB-3909 : Add upgrade step to fix wrongly stored datagrid fields values
[laulaz]
1.1.7 (2023-03-17)
------------------
- Fix non empty fields check after Datagridfield update
[laulaz]
1.1.6 (2023-03-16)
------------------
- Define non empty fields for choices in contact Datagridfield rows & fix labels
[laulaz]
1.1.5 (2023-03-15)
------------------
- Fix "required field" errors in empty Datagridfield rows
[laulaz]
1.1.4 (2023-03-13)
------------------
- Add warning message if images are too small to be cropped
[laulaz]
- Migrate to Plone 6.0.2
[boulch]
1.1.3 (2023-02-28)
------------------
- Avoid auto-appending new lines to Datagrid fields when clicked
[laulaz]
- Fix reindex after cut / copy / paste in some cases
[laulaz]
- Add DE translations in contact_category taxonomy
[laulaz]
1.1.2 (2023-02-20)
------------------
- Remove unused title_fr and description_fr metadatas
[laulaz]
- Remove SearchableText_fr (Solr will use SearchableText for FR)
[laulaz]
1.1.1 (2023-01-12)
------------------
- Add taxonomy_contact_category_for_filtering index to allow complex queries
from smartweb directory views
[laulaz]
- Add new descriptions metadatas and SearchableText indexes for multilingual
[laulaz]
1.1 (2022-12-20)
----------------
- Update to Plone 6.0.0 final
[boulch]
- Add eea.faceted.navigable behavior on Entity type
[laulaz]
1.0 (2022-11-15)
----------------
- Add multilingual features: New fields, vocabularies translations, restapi serializer
[laulaz]
1.0a7 (2022-10-28)
------------------
- Fix translation
[boulch]
- WEB-3762 : Reorder contact fields to encourage good completion + add some fields descriptions
[boulch]
1.0a6 (2022-10-21)
------------------
- WEB-3770 : Force include_items in serializer to True to get files and pictures included in contact
[boulch]
- Add eea.faceted.navigable behavior on Entity type
[laulaz]
1.0a5 (2022-08-09)
------------------
- WEB-3726 : Add subjects (keyword) in SearchableText
[boulch]
1.0a4 (2022-07-14)
------------------
- Update contact_category taxonomy data to reflect production site data
[laulaz]
- [WEBMIGP5-36] Add new vocabulary terms in imio.directory.vocabulary.SiteTypes (Instagram, Pinterest, Youtube)
[boulch]
- It's not allowed to put Images or Files in imio.directory.Entity
[boulch]
1.0a3 (2022-05-03)
------------------
- Use unique urls for images scales to ease caching
[boulch]
- Use common.interfaces.ILocalManagerAware to mark a locally manageable content
[boulch]
1.0a2 (2022-02-11)
------------------
- Add more checks / automatic corrections in contacts CSV import
[laulaz]
- Update buildout to use Plone 6.0.0a3 packages versions
[boulch]
1.0a1 (2022-01-25)
------------------
- Initial release.
[boulch]
Raw data
{
"_id": null,
"home_page": "https://github.com/imio/imio.directory.core",
"name": "imio.directory.core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Python Plone CMS",
"author": "Christophe Boulanger",
"author_email": "christophe.boulanger@imio.be",
"download_url": "https://files.pythonhosted.org/packages/8f/f7/1bc96060f29c6703be5af2a43a7712c59cd34382eaaed9c977e46ab639ce/imio.directory.core-1.2.10.tar.gz",
"platform": null,
"description": ".. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html\n This text does not appear on pypi or github. It is a comment.\n\n.. image:: https://github.com/IMIO/imio.directory.core/workflows/Tests/badge.svg\n :target: https://github.com/IMIO/imio.directory.core/actions?query=workflow%3ATests\n :alt: CI Status\n\n.. image:: https://coveralls.io/repos/github/IMIO/imio.directory.core/badge.svg?branch=main\n :target: https://coveralls.io/github/IMIO/imio.directory.core?branch=main\n :alt: Coveralls\n\n.. image:: https://img.shields.io/pypi/v/imio.directory.core.svg\n :target: https://pypi.python.org/pypi/imio.directory.core/\n :alt: Latest Version\n\n.. image:: https://img.shields.io/pypi/status/imio.directory.core.svg\n :target: https://pypi.python.org/pypi/imio.directory.core\n :alt: Egg Status\n\n.. image:: https://img.shields.io/pypi/pyversions/imio.directory.core.svg?style=plastic :alt: Supported - Python Versions\n\n.. image:: https://img.shields.io/pypi/l/imio.directory.core.svg\n :target: https://pypi.python.org/pypi/imio.directory.core/\n :alt: License\n\n\n===================\nimio.directory.core\n===================\n\nDirectory product for 'Contacts authentic source' website\n\n\nFeatures\n--------\n\nThis products contains two content types: Entity & Contact.\n\nAn entity is bound to one or more belgian zip codes and contains editable geolocated contacts.\n\nA contact can be exported to a vcard file using an object action.\n\nThis directory product is made to be used only by editors, to build the authentic source.\nThe website is then queried (RESTAPI) from other iMio websites.\nContacts are displayed in those sites by `imio.smartweb.core <https://github.com/IMIO/imio.smartweb.core>`_ contact section.\n\n\nExamples\n--------\n\n- https://annuaire.enwallonie.be\n\n\nDocumentation\n-------------\n\nContact can be import from a CSV file via an action on the right Entity.\nCSV Delimiter is \";\"? and columns must be :\n\n================ ============================================================\nColumn Index Data\n================ ============================================================\n00 contact type\n01 title\n02 subtitle\n03 description\n04 street\n05 number\n06 complement\n07 zipcode\n08 city\n09 country\n10 vat number\n11 latitude\n12 longitude\n13 phone label 1\n14 phone type 1\n15 phone number 1\n16 phone label 2\n17 phone type 2\n18 phone number 2\n19 phone label 3\n20 phone type 3\n21 phone number 3\n22 mail label 1\n23 mail type 1\n24 mail address 1\n25 mail label 2\n26 mail type 2\n27 mail address 2\n28 mail label 3\n29 mail type 3\n30 mail address 3\n31 url type 1\n32 url link 1\n33 url type 2\n34 url link 2\n35 url type 3\n36 url link 3\n37 topic 1\n38 topic 2\n39 topic 3\n40 category 1\n41 category 2\n42 category 3\n43 facility 1\n44 facility 2\n45 facility 3\n46 iam 1\n47 iam 2\n48 iam 3\n================ ============================================================\n\n\nTranslations\n------------\n\nThis product has been translated into\n\n- French\n\nThe translation domain is ``imio.smartweb`` and the translations are stored in `imio.smartweb.locales <https://github.com/IMIO/imio.smartweb.locales>`_ package.\n\n\nInstallation\n------------\n\nInstall imio.directory.core by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n\n imio.directory.core\n\n\nand then running ``bin/buildout``\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/imio.directory.core/issues\n- Source Code: https://github.com/collective/imio.directory.core\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\nContributors\n============\n\n- Christophe Boulanger, christophe.boulanger@imio.be\n- Laurent Lasudry, laurent.lasudry@affinitic.be\n\n\nChangelog\n=========\n\n\n1.2.10 (2024-04-10)\n-------------------\n\n- WEB-4095 : Use \"|\" separator instead of \",\" when exporting contacts to csv file\n [boulch]\n\n\n1.2.9 (2024-02-27)\n------------------\n\n- WEB-4072, WEB-4073 : Enable solr.fields behavior on some content types\n [remdub]\n\n- WEB-4006 : Exclude some content types from search results\n [remdub]\n\n\n1.2.8 (2024-02-12)\n------------------\n\n- MWEBRCHA-14 : Add view to export contacts to csv file\n [boulch]\n\n\n1.2.7 (2024-02-02)\n------------------\n\n- SUP-34841 : Fix contact serializer when contact hasn't schedule\n [boulch]\n\n\n1.2.6 (2024-01-31)\n------------------\n\n- WEB-4006 : Also reindex solr on SearchableText upgrade step\n [remdub]\n\n\n1.2.5 (2024-01-31)\n------------------\n\n- WEB-4006 : Add mail and phone labels in SearchableText\n [remdub]\n\n\n1.2.4 (2024-01-17)\n------------------\n\n- WEB-4052 : If all values in schedule are \"\" then we set \"table_date\" to None\n [boulch]\n\n\n1.2.3 (2024-01-09)\n------------------\n\n- WEB-4041 : Handle new \"carre\" scale\n [boulch]\n\n- WEB-4007 : Update contact serializer and use ContactProperties to get well formated schedule\n and help displaying schedule in REACT directory view\n [boulch]\n\n\n1.2.2 (2023-11-20)\n------------------\n\n- WEB-4018 : Add three new terms in facitilites vocabulary\n [boulch]\n\n- Fix missing values for topics / iam lists (causing `None` in REST views filters)\n See https://github.com/collective/collective.solr/issues/366\n [laulaz]\n\n\n1.2.1 (2023-10-26)\n------------------\n\n- Remove logo field from cropping editor\n [laulaz]\n\n\n1.2 (2023-10-25)\n----------------\n\n- WEB-3985 : Use new portrait / paysage scales & logic\n [boulch, laulaz]\n\n- WEB-3985 : Remove old cropping information when image changes\n [boulch, laulaz]\n\n\n1.1.11 (2023-10-25)\n-------------------\n\n- MWEBITTA-21 : Add entities subscribing to share all contacts\n [boulch, laulaz]\n\n\n1.1.10 (2023-10-09)\n-------------------\n\n- WEB-3918 : Add missing DE translations for contact_category taxonomy\n [laulaz]\n\n- Update contact_category taxonomy data to reflect production site data\n [laulaz]\n\n\n1.1.9 (2023-05-26)\n------------------\n\n- Fix condition when facing `Missing.Value` to avoid traceback in serializer\n [laulaz]\n\n- WEB-3918 : Add missing DE translations for contact_category taxonomy\n [laulaz]\n\n- Migrate to Plone 6.0.4\n [boulch]\n\n- Update contact_category taxonomy data to reflect production site data\n [laulaz]\n\n\n1.1.8 (2023-03-31)\n------------------\n\n- WEB-3909 : Add upgrade step to fix wrongly stored datagrid fields values\n [laulaz]\n\n\n1.1.7 (2023-03-17)\n------------------\n\n- Fix non empty fields check after Datagridfield update\n [laulaz]\n\n\n1.1.6 (2023-03-16)\n------------------\n\n- Define non empty fields for choices in contact Datagridfield rows & fix labels\n [laulaz]\n\n\n1.1.5 (2023-03-15)\n------------------\n\n- Fix \"required field\" errors in empty Datagridfield rows\n [laulaz]\n\n\n1.1.4 (2023-03-13)\n------------------\n\n- Add warning message if images are too small to be cropped\n [laulaz]\n\n- Migrate to Plone 6.0.2\n [boulch]\n\n\n1.1.3 (2023-02-28)\n------------------\n\n- Avoid auto-appending new lines to Datagrid fields when clicked\n [laulaz]\n\n- Fix reindex after cut / copy / paste in some cases\n [laulaz]\n\n- Add DE translations in contact_category taxonomy\n [laulaz]\n\n\n1.1.2 (2023-02-20)\n------------------\n\n- Remove unused title_fr and description_fr metadatas\n [laulaz]\n\n- Remove SearchableText_fr (Solr will use SearchableText for FR)\n [laulaz]\n\n\n1.1.1 (2023-01-12)\n------------------\n\n- Add taxonomy_contact_category_for_filtering index to allow complex queries\n from smartweb directory views\n [laulaz]\n\n- Add new descriptions metadatas and SearchableText indexes for multilingual\n [laulaz]\n\n\n1.1 (2022-12-20)\n----------------\n\n- Update to Plone 6.0.0 final\n [boulch]\n\n- Add eea.faceted.navigable behavior on Entity type\n [laulaz]\n\n\n1.0 (2022-11-15)\n----------------\n\n- Add multilingual features: New fields, vocabularies translations, restapi serializer\n [laulaz]\n\n\n1.0a7 (2022-10-28)\n------------------\n\n- Fix translation\n [boulch]\n\n- WEB-3762 : Reorder contact fields to encourage good completion + add some fields descriptions\n [boulch]\n\n\n1.0a6 (2022-10-21)\n------------------\n\n- WEB-3770 : Force include_items in serializer to True to get files and pictures included in contact\n [boulch]\n\n- Add eea.faceted.navigable behavior on Entity type\n [laulaz]\n\n\n1.0a5 (2022-08-09)\n------------------\n\n- WEB-3726 : Add subjects (keyword) in SearchableText\n [boulch]\n\n\n1.0a4 (2022-07-14)\n------------------\n\n- Update contact_category taxonomy data to reflect production site data\n [laulaz]\n\n- [WEBMIGP5-36] Add new vocabulary terms in imio.directory.vocabulary.SiteTypes (Instagram, Pinterest, Youtube)\n [boulch]\n\n- It's not allowed to put Images or Files in imio.directory.Entity\n [boulch]\n\n\n1.0a3 (2022-05-03)\n------------------\n\n- Use unique urls for images scales to ease caching\n [boulch]\n\n- Use common.interfaces.ILocalManagerAware to mark a locally manageable content\n [boulch]\n\n\n1.0a2 (2022-02-11)\n------------------\n\n- Add more checks / automatic corrections in contacts CSV import\n [laulaz]\n\n- Update buildout to use Plone 6.0.0a3 packages versions\n [boulch]\n\n\n1.0a1 (2022-01-25)\n------------------\n\n- Initial release.\n [boulch]\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Core product for iMio contacts Directory websites",
"version": "1.2.10",
"project_urls": {
"Homepage": "https://github.com/imio/imio.directory.core",
"PyPI": "https://pypi.python.org/pypi/imio.directory.core",
"Source": "https://github.com/imio/imio.directory.core",
"Tracker": "https://github.com/imio/imio.directory.core/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "374c7bb654c1a9ab0829d58a61d5c9d6e372af4f3de5fd4a4542b77d8be7b76f",
"md5": "7f48bf8cb2030008fe3ffe56abf2cb7f",
"sha256": "b1d0f0384a14a742af1a8dd4ecef83d061579bdbd54ab7fc910c56021a3daaca"
},
"downloads": -1,
"filename": "imio.directory.core-1.2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f48bf8cb2030008fe3ffe56abf2cb7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 97087,
"upload_time": "2024-04-10T14:18:00",
"upload_time_iso_8601": "2024-04-10T14:18:00.024819Z",
"url": "https://files.pythonhosted.org/packages/37/4c/7bb654c1a9ab0829d58a61d5c9d6e372af4f3de5fd4a4542b77d8be7b76f/imio.directory.core-1.2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8ff71bc96060f29c6703be5af2a43a7712c59cd34382eaaed9c977e46ab639ce",
"md5": "40876ab9ecbecb9cdf5550d428f907e6",
"sha256": "785e3e10d89fabb63b1f6eb51a00ee5eebd0b018a05e777b185b48b6d1de009c"
},
"downloads": -1,
"filename": "imio.directory.core-1.2.10.tar.gz",
"has_sig": false,
"md5_digest": "40876ab9ecbecb9cdf5550d428f907e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 83898,
"upload_time": "2024-04-10T14:18:02",
"upload_time_iso_8601": "2024-04-10T14:18:02.217533Z",
"url": "https://files.pythonhosted.org/packages/8f/f7/1bc96060f29c6703be5af2a43a7712c59cd34382eaaed9c977e46ab639ce/imio.directory.core-1.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 14:18:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "imio",
"github_project": "imio.directory.core",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "imio.directory.core"
}