| Name | neoassistant JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | |
| Summary | A CLI application that helps to manage contacts and notes. |
| upload_time | 2023-11-06 07:02:38 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Zakir Nuriiev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
assistant
contacts
notes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Neoassistant Bot
Neoassistant Bot is a Python-based assistant that allows you to manage contacts and notes through a command-line interface. This README will guide you through using the bot and provide essential information about the codebase.
## Table of Contents
[Features](#features)
[Prerequisites](#prerequisites)
[Usage](#usage)
[Commands](#commands)
[License](#license)
## Features
- Manage Contacts: Add, update, delete, and search for contacts.
- Manage Notes: Add, update, delete, and search for notes.
- Command-Line Interface (CLI): Interact with the bot using commands.
- Data Persistence: The bot can save and load data to/from a binary file.
## Prerequisites
Before using Neoassistant Bot, ensure you have the following dependencies installed:
- Python 3.x
- Required Python packages (specified in the code)
## Usage
1. You can install the application via pip to your local machine (for Mac use pip3 command):
```bash
pip install neoassistant
```
2. Run the main Python script anywhere in the console (two options):
```bash
python -m neoassistant
# or you can write the following command anywhere in the console:
neoassistant
```
4. The bot will start, and you can interact with it by entering commands.
## Commands
The bot supports the following commands:
- add: Add a new contact.
- change: Change a contact.
- delete: Delete a contact.
- show: Show contact information.
- all: Show all contacts.
- show-birthdays: Show upcoming birthdays.
- filter: Filter contacts by criteria.
- add-note: Add a new note.
- change-note: Change a note.
- delete-note: Delete a note.
- show-note: Show a note.
- all-notes: Show all notes.
- filter-notes: Filter notes by criteria.
- filter-notes-by-tags: Filter notes by tags.
- exit or close: Exit the program.
- help: Show available commands.
The bot provides suggestions for commands if a command is not recognised.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to modify and expand upon this README as needed for your project. You can include information about the code structure, additional usage examples, or any other relevant details.
Raw data
{
"_id": null,
"home_page": "",
"name": "neoassistant",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "assistant,contacts,notes",
"author": "",
"author_email": "Illja <a4grtu@gmail.com>, Olha Levchenko <olgakazakovskaya@ukr.net>, Vladyslav Mazur <vladopermoz@gmail.com>, Zakir Nuriiev <kazamov@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/59/2d/4df83a95593a467c3838a83979aff92c14d5d5ffcc1653ae641a7fa437cd/neoassistant-0.1.4.tar.gz",
"platform": null,
"description": "\r\n# Neoassistant Bot\r\n\r\n \r\nNeoassistant Bot is a Python-based assistant that allows you to manage contacts and notes through a command-line interface. This README will guide you through using the bot and provide essential information about the codebase.\r\n\r\n \r\n\r\n## Table of Contents\r\n\r\n \r\n\r\n[Features](#features)\r\n\r\n[Prerequisites](#prerequisites)\r\n\r\n[Usage](#usage)\r\n\r\n[Commands](#commands)\r\n\r\n[License](#license)\r\n\r\n \r\n\r\n## Features\r\n\r\n \r\n\r\n- Manage Contacts: Add, update, delete, and search for contacts.\r\n\r\n- Manage Notes: Add, update, delete, and search for notes.\r\n\r\n- Command-Line Interface (CLI): Interact with the bot using commands.\r\n\r\n- Data Persistence: The bot can save and load data to/from a binary file.\r\n\r\n \r\n\r\n## Prerequisites\r\n\r\n \r\nBefore using Neoassistant Bot, ensure you have the following dependencies installed:\r\n\r\n- Python 3.x\r\n\r\n- Required Python packages (specified in the code)\r\n\r\n \r\n\r\n## Usage\r\n\r\n \r\n1. You can install the application via pip to your local machine (for Mac use pip3 command):\r\n\r\n\r\n```bash\r\npip install neoassistant\r\n```\r\n\r\n2. Run the main Python script anywhere in the console (two options):\r\n```bash\r\npython -m neoassistant\r\n# or you can write the following command anywhere in the console:\r\nneoassistant\r\n```\r\n4. The bot will start, and you can interact with it by entering commands.\r\n\r\n \r\n\r\n## Commands\r\n\r\n \r\n\r\nThe bot supports the following commands:\r\n\r\n \r\n\r\n- add: Add a new contact.\r\n\r\n- change: Change a contact.\r\n\r\n- delete: Delete a contact.\r\n\r\n- show: Show contact information.\r\n\r\n- all: Show all contacts.\r\n\r\n- show-birthdays: Show upcoming birthdays.\r\n\r\n- filter: Filter contacts by criteria.\r\n\r\n- add-note: Add a new note.\r\n\r\n- change-note: Change a note.\r\n\r\n- delete-note: Delete a note.\r\n\r\n- show-note: Show a note.\r\n\r\n- all-notes: Show all notes.\r\n\r\n- filter-notes: Filter notes by criteria.\r\n\r\n- filter-notes-by-tags: Filter notes by tags.\r\n\r\n- exit or close: Exit the program.\r\n\r\n- help: Show available commands.\r\n\r\nThe bot provides suggestions for commands if a command is not recognised.\r\n\r\n \r\n\r\n## License\r\n\r\n \r\n\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n\r\n \r\n\r\nFeel free to modify and expand upon this README as needed for your project. You can include information about the code structure, additional usage examples, or any other relevant details.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Zakir Nuriiev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A CLI application that helps to manage contacts and notes.",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/kazamov/goitneo-python-final-project-group-11/"
},
"split_keywords": [
"assistant",
"contacts",
"notes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5716291f5631e283d9b816307dfae4370b9209a725497be2a442c5585b89dce2",
"md5": "42c9edc8bfd6a7021ef440e7d07106bc",
"sha256": "9bdb40c6b7309a814f17a51815885d80708e8f137712c59545b3b5c6078fdcfb"
},
"downloads": -1,
"filename": "neoassistant-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "42c9edc8bfd6a7021ef440e7d07106bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13185,
"upload_time": "2023-11-06T07:02:37",
"upload_time_iso_8601": "2023-11-06T07:02:37.380518Z",
"url": "https://files.pythonhosted.org/packages/57/16/291f5631e283d9b816307dfae4370b9209a725497be2a442c5585b89dce2/neoassistant-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "592d4df83a95593a467c3838a83979aff92c14d5d5ffcc1653ae641a7fa437cd",
"md5": "66e8233c4cd483cd20e2d57e446d6dc3",
"sha256": "7e662fd2a62e6414d0c8fec919089f144982ddd9d1ae9dd0fc4909428892baee"
},
"downloads": -1,
"filename": "neoassistant-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "66e8233c4cd483cd20e2d57e446d6dc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11955,
"upload_time": "2023-11-06T07:02:38",
"upload_time_iso_8601": "2023-11-06T07:02:38.407650Z",
"url": "https://files.pythonhosted.org/packages/59/2d/4df83a95593a467c3838a83979aff92c14d5d5ffcc1653ae641a7fa437cd/neoassistant-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-06 07:02:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kazamov",
"github_project": "goitneo-python-final-project-group-11",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "neoassistant"
}
