One Message
=====
Django Message
Installation and usage
======================
Quick start
-----------
1. Add "message" to your INSTALLED_APPS setting like this::
``` python
INSTALLED_APPS = [
...,
"message",
]
```
2. Add "message tags" to your TEMPLATES Options setting like this::
```
"builtins": [
"message.templatetags.swal_message",
]
```
3. Add "message" to your base.html like this::
```html
{% swal_message_media True %} # If your template already add jquery and bootstrap, you can set this to False
</head>
{% include 'riso-message/messaging.html' %}
</body>
```
How to contribute
=================
Please make sure to update tests as appropriate.
Getting Started
---------------
1. Clone the repository
``` bash
# Run the following command in your terminal
pre-commit install
git update-index --assume-unchanged .idea/runConfigurations/* .idea/riso.iml
```
2. Prepare the environment, Create a virtual environment with Python 3.11 or higher and activate it. Then install the
dependencies using pip:
``` bash
# Run the following command in your terminal
cd riso
pip install -r requirements.txt
```
3. Update following files
```
# .envs/.local/.django
# .envs/.local/.postgres
```
4. Then using pycharm runConfiguration to start coding
Useful commands
---------------
- Run test with coverage
``` bash
docker-compose -f riso/local.yml run --rm django pytest --cov --cov-report term-missing --cov-report html
```
Other information
=================
What's in this project?
-----------------------
This project is a Django project with a single app called "message".
Raw data
{
"_id": null,
"home_page": "https://github.com/RisoTech-Hub/one-message",
"name": "riso-message",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "",
"author": "Bin Nguyen",
"author_email": "tu.nguyen@risotech.vn",
"download_url": "https://files.pythonhosted.org/packages/93/08/5cf51997bbea59643925af83fff5517947420cd0b4fdb0ca57240eba9695/riso-message-0.1.5.tar.gz",
"platform": null,
"description": "One Message\n=====\n\nDjango Message\n\n\nInstallation and usage\n======================\n\nQuick start\n-----------\n\n1. Add \"message\" to your INSTALLED_APPS setting like this::\n\n ``` python\n INSTALLED_APPS = [\n ...,\n \"message\",\n ]\n ```\n2. Add \"message tags\" to your TEMPLATES Options setting like this::\n\n ```\n \"builtins\": [\n \"message.templatetags.swal_message\",\n ]\n ```\n\n3. Add \"message\" to your base.html like this::\n\n ```html\n {% swal_message_media True %} # If your template already add jquery and bootstrap, you can set this to False\n </head>\n\n {% include 'riso-message/messaging.html' %}\n </body>\n ```\n\nHow to contribute\n=================\n\nPlease make sure to update tests as appropriate.\n\nGetting Started\n---------------\n\n1. Clone the repository\n\n ``` bash\n # Run the following command in your terminal\n pre-commit install\n git update-index --assume-unchanged .idea/runConfigurations/* .idea/riso.iml\n ```\n\n2. Prepare the environment, Create a virtual environment with Python 3.11 or higher and activate it. Then install the\n dependencies using pip:\n\n ``` bash\n # Run the following command in your terminal\n cd riso\n pip install -r requirements.txt\n ```\n\n3. Update following files\n\n ```\n # .envs/.local/.django\n # .envs/.local/.postgres\n ```\n\n4. Then using pycharm runConfiguration to start coding\n\nUseful commands\n---------------\n\n- Run test with coverage\n\n ``` bash\n docker-compose -f riso/local.yml run --rm django pytest --cov --cov-report term-missing --cov-report html\n ```\n\nOther information\n=================\n\nWhat's in this project?\n-----------------------\n\nThis project is a Django project with a single app called \"message\".\n",
"bugtrack_url": null,
"license": "",
"summary": "Django Message",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/RisoTech-Hub/one-message"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93085cf51997bbea59643925af83fff5517947420cd0b4fdb0ca57240eba9695",
"md5": "1b3f94828e3cb4b1f71c9bef054e777b",
"sha256": "3d3ea6bc437b0139b8e6a95bf53d106dca70f64fbb92d29539fb4101dd5f19a9"
},
"downloads": -1,
"filename": "riso-message-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "1b3f94828e3cb4b1f71c9bef054e777b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 153596,
"upload_time": "2023-09-11T15:34:12",
"upload_time_iso_8601": "2023-09-11T15:34:12.038137Z",
"url": "https://files.pythonhosted.org/packages/93/08/5cf51997bbea59643925af83fff5517947420cd0b4fdb0ca57240eba9695/riso-message-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-11 15:34:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RisoTech-Hub",
"github_project": "one-message",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "riso-message"
}
JSON
