{"id":19156067,"url":"https://github.com/mozancetin/sqlite-image-handler","last_synced_at":"2025-05-07T07:34:10.343Z","repository":{"id":57470588,"uuid":"387912186","full_name":"mozancetin/SQLite-Image-Handler","owner":"mozancetin","description":"Simple to use image handler for python sqlite3.","archived":false,"fork":false,"pushed_at":"2021-08-01T16:05:28.000Z","size":81,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-17T06:44:38.141Z","etag":null,"topics":["database","python","python-sqlite3","python3","sql","sqlite","sqlite3-image"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/SQLiteImageHandler/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mozancetin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-20T20:56:46.000Z","updated_at":"2023-07-29T22:09:05.000Z","dependencies_parsed_at":"2022-09-26T17:40:33.794Z","dependency_job_id":null,"html_url":"https://github.com/mozancetin/SQLite-Image-Handler","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozancetin%2FSQLite-Image-Handler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozancetin%2FSQLite-Image-Handler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozancetin%2FSQLite-Image-Handler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mozancetin%2FSQLite-Image-Handler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mozancetin","download_url":"https://codeload.github.com/mozancetin/SQLite-Image-Handler/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252834025,"owners_count":21811299,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","python","python-sqlite3","python3","sql","sqlite","sqlite3-image"],"created_at":"2024-11-09T08:33:07.683Z","updated_at":"2025-05-07T07:34:10.318Z","avatar_url":"https://github.com/mozancetin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQLite Image Handler\nSimple to use image handler for python sqlite3.\n\n# Functions\nFunction Name | Parameters | Returns\n------------- | ---------- | -------\n**[init]** | **databasePath** : *str* \u003cbr\u003e **tableName** : *str* | - |\n**[startConnection]** | - | - |\n**[imageSelector]** | **path** : *str* | **bytesContent** : *bytes* \u003cbr\u003e **extensionType** : *str* |\n**[addImage]** | **imageName** : *str* \u003cbr\u003e **imageBytes** : *bytes* \u003cbr\u003e **extensionType** : *str* | - |\n**[getSaveImage]** | **imageName** : *str* \u003cbr\u003e **savePath** : *str* | - |\n**[isImageExists]** | **imageName** : *str* | **isExists** : *bool* |\n**[deleteImage]** | **imageName** : *str* | - |\n**[updateImage]** | **imageName** : *str* \u003cbr\u003e **newImageBytes** : *bytes* \u003cbr\u003e **newExtensionType** : *str* | - |\n\n[See definitions](#definitions)\n\n[init]: #initselfdatabasepath--str--databasedb-tablename--str--images---none\n\n[startConnection]: #startconnectionself---none\n\n[imageSelector]: #imageselectorself-path--str--none---bytescontentbytes-extensiontypestr\n\n[addImage]: #addimageself-imagename--str-imagebytes--bytes-extensiontype--str--png---none\n\n[getSaveImage]: #getsaveimageself-imagename--str--none-savepath--str--savedimage---none\n\n[isImageExists]: #isimageexistsself-imagename--str--none---isexistsbool\n\n[deleteImage]: #deleteimageself-imagename--str--none---none\n\n[updateImage]: #updateimageself-imagename--str--none-newimagebytes--bytes--none-newextensiontype--str--none---none\n\n# Usage\n\n- \u003ch3\u003eImporting \u0026 Creating Handler\u003c/h3\u003e\n\n```python\nfrom SQLiteImageHandler.SQLiteImageHandler import ImageHandler\n\nhandler = ImageHandler(databasePath = \"database.db\", tableName = \"myimages\")\n```\n\u003chr\u003e\n\n- \u003ch3\u003eAdding an image to the database\u003c/h3\u003e\n\n```python\nhandler.addImage(imageName = \"Image 1\", *handler.imageSelector(path = r\"C:\\Users\\mozancetin\\Desktop\\myimage1.png\"))\n```\n\u003chr\u003e\n\n- \u003ch3\u003eSaving image from database to computer\u003c/h3\u003e\n\n```python\n# If you want, use a save name like \"savedImage\" instead of \"savedImage.png\"\n# ..because whatever you write, it will automatically fetch the extension from the database.\nhandler.getSaveImage(imageName = \"Image 1\", savePath = r\"C:\\Users\\mozancetin\\Desktop\\savedImage.png\")\n```\n\u003chr\u003e\n\n- \u003ch3\u003eUpdating the image in the database\u003c/h3\u003e\n\n```python\nhandler.updateImage(imageName = \"Image 1\", *handler.imageSelector(path=r\"C:\\Users\\mozancetin\\Desktop\\myimage2.png\"))\n```\n\u003chr\u003e\n\n- \u003ch3\u003eDeleting an image from database\u003c/h3\u003e\n\n```python\nhandler.deleteImage(imageName = \"Image 1\")\n```\n\u003chr\u003e\n\n- \u003ch3\u003eCheck if image exists in the database\u003c/h3\u003e\n\n```python\nisExists = handler.isImageExists(imageName = \"Image 1\")\nprint(isExists)\n```\n\u003chr\u003e\n\n- \u003ch3\u003eGet bytes of image and extension type\u003c/h3\u003e\n\n```python\nbytesOfImage, extensionType = handler.imageSelector(path=r\"C:\\Users\\mozancetin\\Desktop\\myimage1.png\")\nprint(\"Bytes Length: \" + str(len(bytesOfImage)) + \"\\nExtension Type: \" + extensionType)\n```\n\u003chr\u003e\n\u003cbr\u003e\n\n# Definitions\n\n### __init__(self,databasePath : str = \"database.db\", tableName : str = \"images\") -\u003e None\n\n- Sets the *self.databasePath*, *self.tableName* and calls *startConnection()* func.\n\n\u003chr\u003e\n\n### startConnection(self) -\u003e None\n\n- Starts the connection with SQLite Database.\n\n\u003chr\u003e\n\n### imageSelector(self, path : str = None) -\u003e bytesContent[bytes], extensionType[str]\n\n- Selects an image and returns the image's *bytes content* and *extension type*.\n- **bytesContent[bytes]:** *Bytes content of image.*\n- **extensionType[str]:** *Extension type like png, jpg or something...*\n\n\u003chr\u003e\n\n### addImage(self, imageName : str, imageBytes : bytes, extensionType : str = \"png\") -\u003e None\n\n- Adds an image to database.\n\n\u003chr\u003e\n\n### getSaveImage(self, imageName : str = None, savePath : str = \"savedImage\") -\u003e None\n\n- Saves the *previously saved image in the database* as an *image to the given path*.\n\n\u003chr\u003e\n\n### isImageExists(self, imageName : str = None) -\u003e isExists[bool]\n\n- Checks if image exists in database *by image name*.\n- **isExists[bool]:** *True if image exists in the database otherwise False*\n\n\u003chr\u003e\n\n### deleteImage(self, imageName : str = None) -\u003e None\n\n- Deletes image *by name in database*.\n\n\u003chr\u003e\n\n### updateImage(self, imageName : str = None, newImageBytes : bytes = None, newExtensionType : str = None) -\u003e None\n\n- Updates image *by name in database*.\n\n\u003chr\u003e\n\u003cbr\u003e\n\n# CMD Things\n\n```cmd\nC:\\Users\\mozancetin\\Desktop\\Handler\u003epython SQLiteImageHandler\n\nusage: SQLiteImageHandler [-h] [-v] [--database-path DBPATH] [--table-name TABLENAME] [-a] [-sn SAVE_NAME]\n                          [-ip IMAGE_PATH] [-s] [-sdn SAVED_NAME] [-sp SAVE_PATH] [-u] [-in IMAGE_NAME]\n                          [-uip UPDATE_IMAGE_PATH] [-d] [-c] [-is]\n\nSQLite Image Handler.\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -v, --version         show program's version number and exit\n  --database-path DBPATH\n                        database path.\n  --table-name TABLENAME\n                        table name of the database\n\nAdd an Image:\n  Adding an image to the database.\n\n  -a, --add-image       Adds an image to database. (Requires -sn and -ip)\n  -sn SAVE_NAME, --save-name SAVE_NAME\n                        Save name of image.\n  -ip IMAGE_PATH, --image-path IMAGE_PATH\n                        Path of the selected image\n\nSave an Image:\n  Saving image from database to computer.\n\n  -s, --save-image      Saves the previously saved image in the database as an image to the given path. (Requires -sdn\n                        and -sp)\n  -sdn SAVED_NAME, --saved-name SAVED_NAME\n                        Saved name of image in the database.\n  -sp SAVE_PATH, --save-path SAVE_PATH\n                        Save path. (default: savedImage.png)\n\nUpdate an Image:\n  Updating the image in the database.\n\n  -u, --update-image    Updates image by name in database. (Requires -in and -uip)\n  -in IMAGE_NAME, --image-name IMAGE_NAME\n                        Saved name of image in the database.\n  -uip UPDATE_IMAGE_PATH, --update-image-path UPDATE_IMAGE_PATH\n                        Path of the selected image\n\nDelete an Image:\n  Deleting an image from database\n\n  -d, --delete          Deletes image by name in database. (Requires -in)\n\nOther:\n  -c, --check           Checks if image exists in database by image name. (Requires -in)\n  -is, --image-selector\n                        Selects an image and returns the image's bytes length and extension type. (Requires -ip)\n```\n\n# TODO's\n- [x] Write a readme file\n- [x] Add different types of images (Right now just png is supported)\n- [x] Add more explanation to functions\n- [x] Add deletePhoto, updatePhoto functions\n- [x] Raise some errors\n- [x] Add Usage to readme\n- [x] Upload to pypi\n- [x] Write a description of each function for README\n- [x] Add some cmd things\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozancetin%2Fsqlite-image-handler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmozancetin%2Fsqlite-image-handler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmozancetin%2Fsqlite-image-handler/lists"}