Name | techtribe-addressbook JSON |
Version |
1.0.3
JSON |
| download |
home_page | None |
Summary | Save your data easy and convenient |
upload_time | 2024-05-26 18:21:31 |
maintainer | None |
docs_url | None |
author | None |
requires_python | None |
license | The MIT License (MIT) Copyright © 2024 TechTribe 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 |
addressbook
techtribe
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# TechTribe
Final project for Python Programming: Foundations and Best Practices 2.0
## Description
A terminal application that allows users to create, read, update, and delete contacts.
Users can also view all contacts, view contact by name, and search for contacts by keyword.
Also implemented opportunity to save notes separate from contacts.
User can save, edit, delete and search note by title.
Also added opportunity to add tags to any note, delete tag and find note by tag.
## Installation
1. Clone the repository
2. Create a virtual environment in the project directory: python -m venv .venv
3. Activate the virtual environment: source .venv/bin/activate
4. Install the required packages: pip install -r requirements.txt
5. Run the application: python main.py
## Usage
Write a command in the terminal to interact with the application
User can use the next commands:
- `add <name> <phone>` to add a new contact
- `add_birthday <name> <date>` to add a birthday to a contact
- `add_address <name> <street> <city> <postal_code> <country>` to add an address to a contact
- `edit_address <name> <street> <city> <postal_code> <country>` to edit an address for a contact
- `add_email <name> <email>` to add an email to a contact
- `edit_email <name> <oldEmail> <newEmail>` to edit an email for a contact
- `remove_email <name> <email>` to remove an email from a contact
- `show_contact <name>` to show contact
- `find_contacts <query1> <queryN>` to find contacts by multiple queries
- `show_birthday <name>` to show birthday for a contact
- `birthdays <days>` to show the upcoming birthdays in the next days, default days is `7`
- `change <name> <oldPhone> <newPhone>` to change the phone number of a contact
- `phone <name>` to show the phone numbers of a contact
- `all` to show all contacts
- `delete` to delete contact
- `delete_all` to delete all contacts
- `delete_address <name>` to delete address
- `delete_note <title>` to delete a note
- `add-note <title> <text>` to add a note
- `find-note <title>` to find a note by title
- `edit_note <title> <text>` to edit a note
- `show_notes` - to show all notes that were saved
- `add_tags` - to add many tags to note
- `remove_tags` - to remove tags from note
- `find_by_tags` - to show notes with mentioned tags
- `help` to show the help message
- `exit` to exit the application
- `close` to close the application
User can use check dialogs to select the action or exit.
Raw data
{
"_id": null,
"home_page": null,
"name": "techtribe-addressbook",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "addressbook, techtribe",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f5/2f/ce4eb5120f67899071b86c275da19a7b8d3b5443258cc6c16c2dae53217b/techtribe_addressbook-1.0.3.tar.gz",
"platform": null,
"description": "# TechTribe\nFinal project for Python Programming: Foundations and Best Practices 2.0\n\n## Description\nA terminal application that allows users to create, read, update, and delete contacts.\nUsers can also view all contacts, view contact by name, and search for contacts by keyword.\nAlso implemented opportunity to save notes separate from contacts.\nUser can save, edit, delete and search note by title.\nAlso added opportunity to add tags to any note, delete tag and find note by tag.\n\n## Installation\n1. Clone the repository\n2. Create a virtual environment in the project directory: python -m venv .venv\n3. Activate the virtual environment: source .venv/bin/activate\n4. Install the required packages: pip install -r requirements.txt\n5. Run the application: python main.py\n\n## Usage\nWrite a command in the terminal to interact with the application \nUser can use the next commands:\n- `add <name> <phone>` to add a new contact\n- `add_birthday <name> <date>` to add a birthday to a contact\n- `add_address <name> <street> <city> <postal_code> <country>` to add an address to a contact\n- `edit_address <name> <street> <city> <postal_code> <country>` to edit an address for a contact\n- `add_email <name> <email>` to add an email to a contact\n- `edit_email <name> <oldEmail> <newEmail>` to edit an email for a contact\n- `remove_email <name> <email>` to remove an email from a contact\n- `show_contact <name>` to show contact\n- `find_contacts <query1> <queryN>` to find contacts by multiple queries\n- `show_birthday <name>` to show birthday for a contact\n- `birthdays <days>` to show the upcoming birthdays in the next days, default days is `7`\n- `change <name> <oldPhone> <newPhone>` to change the phone number of a contact\n- `phone <name>` to show the phone numbers of a contact\n- `all` to show all contacts\n- `delete` to delete contact\n- `delete_all` to delete all contacts\n- `delete_address <name>` to delete address\n- `delete_note <title>` to delete a note\n- `add-note <title> <text>` to add a note\n- `find-note <title>` to find a note by title\n- `edit_note <title> <text>` to edit a note\n- `show_notes` - to show all notes that were saved\n- `add_tags` - to add many tags to note\n- `remove_tags` - to remove tags from note\n- `find_by_tags` - to show notes with mentioned tags\n- `help` to show the help message\n- `exit` to exit the application\n- `close` to close the application\n\nUser can use check dialogs to select the action or exit.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright \u00a9 2024 TechTribe Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), 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 \u201cAS IS\u201d, 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": "Save your data easy and convenient",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/Oldestgraf/TechTribe"
},
"split_keywords": [
"addressbook",
" techtribe"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b2d8a1428b57738f8712dabaea9d213c67c484cca1263f64df5dd782f0a6452",
"md5": "436443a2b08ee79b457c4d2d01f65543",
"sha256": "0d6b4ed25a819f699c91e639d1683d751562ef32498bf5b2dc3f92640ae4d128"
},
"downloads": -1,
"filename": "techtribe_addressbook-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "436443a2b08ee79b457c4d2d01f65543",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16913,
"upload_time": "2024-05-26T18:21:30",
"upload_time_iso_8601": "2024-05-26T18:21:30.268204Z",
"url": "https://files.pythonhosted.org/packages/1b/2d/8a1428b57738f8712dabaea9d213c67c484cca1263f64df5dd782f0a6452/techtribe_addressbook-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f52fce4eb5120f67899071b86c275da19a7b8d3b5443258cc6c16c2dae53217b",
"md5": "300196e047454e77d47de1dce8ad9549",
"sha256": "a1b138ca09f55e32a602803117bbad945a695ae6684da661f6c6045dba886838"
},
"downloads": -1,
"filename": "techtribe_addressbook-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "300196e047454e77d47de1dce8ad9549",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14013,
"upload_time": "2024-05-26T18:21:31",
"upload_time_iso_8601": "2024-05-26T18:21:31.784818Z",
"url": "https://files.pythonhosted.org/packages/f5/2f/ce4eb5120f67899071b86c275da19a7b8d3b5443258cc6c16c2dae53217b/techtribe_addressbook-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-26 18:21:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Oldestgraf",
"github_project": "TechTribe",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "techtribe-addressbook"
}