Address book plugin for Modoboa
===============================
|gha| |codecov|
Installation
------------
Install this extension system-wide or inside a virtual environment by
running the following command::
$ pip install modoboa-contacts
Edit the settings.py file of your modoboa instance and apply the following modifications:
- add ``modoboa_contacts`` inside the ``MODOBOA_APPS`` variable like this::
MODOBOA_APPS = (
'modoboa',
'modoboa.core',
'modoboa.lib',
'modoboa.admin',
'modoboa.relaydomains',
'modoboa.limits',
'modoboa.parameters',
# Extensions here
# ...
'modoboa_contacts',
)
- Add the following at the end of the file::
from modoboa_contacts import settings as modoboa_contacts_settings
modoboa_contacts_settings.apply(globals())
Finally, run the following commands to setup the database tables::
$ cd <modoboa_instance_dir>
$ python manage.py migrate
$ python manage.py collectstatic
$ python manage.py load_initial_data
For developers
---------------
The frontend part of this plugin is developed with `VueJS 2 <https://vuejs.org/>`_ and
requires `nodejs <https://nodejs.org/en/>`_ and `webpack <https://webpack.js.org/>`_.
Once nodejs is installed on your system, run the following commands::
$ cd frontend
$ npm install
$ npm run serve
To update dist files (the ones that will be distributed with the plugin), run::
$ npm run build
.. |gha| image:: https://github.com/modoboa/modoboa-contacts/actions/workflows/plugin.yml/badge.svg
:target: https://github.com/modoboa/modoboa-contacts/actions/workflows/plugin.yml
.. |codecov| image:: https://codecov.io/gh/modoboa/modoboa-contacts/branch/master/graph/badge.svg
:target: https://codecov.io/gh/modoboa/modoboa-contacts
Raw data
{
"_id": null,
"home_page": "http://modoboa.org/",
"name": "modoboa-contacts",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "email",
"author": "Antoine Nguyen",
"author_email": "tonio@ngyn.org",
"download_url": "https://files.pythonhosted.org/packages/12/39/2d813a7c1403c7640412433ab58c33f23661c117d3fce551e34a6bbc389f/modoboa-contacts-1.1.2.tar.gz",
"platform": null,
"description": "Address book plugin for Modoboa\n===============================\n\n|gha| |codecov|\n\nInstallation\n------------\n\nInstall this extension system-wide or inside a virtual environment by\nrunning the following command::\n\n $ pip install modoboa-contacts\n\nEdit the settings.py file of your modoboa instance and apply the following modifications:\n\n- add ``modoboa_contacts`` inside the ``MODOBOA_APPS`` variable like this::\n\n MODOBOA_APPS = (\n 'modoboa',\n 'modoboa.core',\n 'modoboa.lib',\n 'modoboa.admin',\n 'modoboa.relaydomains',\n 'modoboa.limits',\n 'modoboa.parameters',\n # Extensions here\n # ...\n 'modoboa_contacts',\n )\n\n- Add the following at the end of the file::\n\n from modoboa_contacts import settings as modoboa_contacts_settings\n modoboa_contacts_settings.apply(globals())\n\nFinally, run the following commands to setup the database tables::\n\n $ cd <modoboa_instance_dir>\n $ python manage.py migrate\n $ python manage.py collectstatic\n $ python manage.py load_initial_data\n\nFor developers\n---------------\n\nThe frontend part of this plugin is developed with `VueJS 2 <https://vuejs.org/>`_ and\nrequires `nodejs <https://nodejs.org/en/>`_ and `webpack <https://webpack.js.org/>`_.\n\nOnce nodejs is installed on your system, run the following commands::\n\n $ cd frontend\n $ npm install\n $ npm run serve\n\nTo update dist files (the ones that will be distributed with the plugin), run::\n\n $ npm run build\n\n.. |gha| image:: https://github.com/modoboa/modoboa-contacts/actions/workflows/plugin.yml/badge.svg\n :target: https://github.com/modoboa/modoboa-contacts/actions/workflows/plugin.yml\n\n.. |codecov| image:: https://codecov.io/gh/modoboa/modoboa-contacts/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/modoboa/modoboa-contacts\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Address book for Modoboa",
"version": "1.1.2",
"project_urls": {
"Homepage": "http://modoboa.org/"
},
"split_keywords": [
"email"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c2342f47761b6e7243ebcc1bf43d7eb4f2fee2958fc1ae9d038987f37e15c61",
"md5": "25095d7154f8bd11477bf0f187c78796",
"sha256": "3e83a18f9c1103883c7dac445368ceed66eb536e75f7547fca95b1484ead62c2"
},
"downloads": -1,
"filename": "modoboa_contacts-1.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "25095d7154f8bd11477bf0f187c78796",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 788521,
"upload_time": "2024-04-09T08:29:08",
"upload_time_iso_8601": "2024-04-09T08:29:08.376380Z",
"url": "https://files.pythonhosted.org/packages/5c/23/42f47761b6e7243ebcc1bf43d7eb4f2fee2958fc1ae9d038987f37e15c61/modoboa_contacts-1.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12392d813a7c1403c7640412433ab58c33f23661c117d3fce551e34a6bbc389f",
"md5": "77da17ddcb30ae9e0917d208de05f758",
"sha256": "7f5d0c83ad00610fa49ae885588a95014ab7200dc31208459d2cf7661e509506"
},
"downloads": -1,
"filename": "modoboa-contacts-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "77da17ddcb30ae9e0917d208de05f758",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 973191,
"upload_time": "2024-04-09T08:29:10",
"upload_time_iso_8601": "2024-04-09T08:29:10.005119Z",
"url": "https://files.pythonhosted.org/packages/12/39/2d813a7c1403c7640412433ab58c33f23661c117d3fce551e34a6bbc389f/modoboa-contacts-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 08:29:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "modoboa-contacts"
}
JSON