{"id":18258613,"url":"https://github.com/whizzes/imagekit","last_synced_at":"2025-04-04T19:31:45.825Z","repository":{"id":41877704,"uuid":"510140036","full_name":"whizzes/imagekit","owner":"whizzes","description":"Rust API Client for ImageKit.io a file storage and image processing service","archived":false,"fork":false,"pushed_at":"2023-09-12T05:17:48.000Z","size":114,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T03:05:43.970Z","etag":null,"topics":["api","client","imagekit","rust","sdk"],"latest_commit_sha":null,"homepage":"https://imagekit.io","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whizzes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-03T21:33:33.000Z","updated_at":"2024-11-27T02:40:00.000Z","dependencies_parsed_at":"2024-11-05T10:59:25.458Z","dependency_job_id":null,"html_url":"https://github.com/whizzes/imagekit","commit_stats":null,"previous_names":["estebanborai/imagekit"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whizzes%2Fimagekit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whizzes%2Fimagekit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whizzes%2Fimagekit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whizzes%2Fimagekit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whizzes","download_url":"https://codeload.github.com/whizzes/imagekit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247237679,"owners_count":20906329,"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":["api","client","imagekit","rust","sdk"],"created_at":"2024-11-05T10:33:11.858Z","updated_at":"2025-04-04T19:31:40.817Z","avatar_url":"https://github.com/whizzes.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\n  \u003cdiv align=\"center\"\u003e\n    \u003cimg\n      alt=\"ImageKit Logo\"\n      src=\"https://raw.githubusercontent.com/EstebanBorai/imagekit/main/assets/imagekit.png\"\n      height=\"52\"\n      width=\"250\"\n    /\u003e\n  \u003c/div\u003e\n  \u003ch4 align=\"center\"\u003e\n    Rust API Client for ImageKit.io a file storage and image processing\n    service\n  \u003c/h4\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n  [![Crates.io](https://img.shields.io/crates/v/imagekit.svg)](https://crates.io/crates/imagekit)\n  [![Documentation](https://docs.rs/imagekit/badge.svg)](https://docs.rs/imagekit)\n  ![Build](https://github.com/EstebanBorai/imagekit/workflows/build/badge.svg)\n  ![Clippy](https://github.com/EstebanBorai/imagekit/workflows/clippy/badge.svg)\n  ![Formatter](https://github.com/EstebanBorai/imagekit/workflows/fmt/badge.svg)\n  ![Tests](https://github.com/EstebanBorai/imagekit/workflows/test/badge.svg)\n\n\u003c/div\u003e\n\n## Usage\n\nYou must retrieve your Public and Private Keys from the\n[ImageKit Developer Options][1].\n\nThen create an instance of `ImageKit` and initialize the client.\n\n```rust\nuse imagekit::ImageKit;\nuse imagekit::management::Details;\nuse imagekit::delete::Delete;\nuse imagekit::upload::types::FileType;\nuse imagekit::upload::{Options, Upload, UploadFile};\nuse tokio::fs::File;\n\n#[tokio::main]\nasync fn main() -\u003e Result\u003c(), Box\u003cdyn std::error::Error\u003e\u003e {\n    let mut image_kit = ImageKit::new(\n        \"your_public_api_key\",\n        \"your_private_api_key\",\n        \"https://ik.imagekit.io/your_imagekit_id/\",\n    );\n\n    // Upload an image from File\n    let file = File::open(\"assets/ferris.jpeg\").await.unwrap();\n    let opts = Options::new(upload_file, \"ferris\");\n    let upload_result = imagekit.upload(opts).await.unwrap();\n\n    // Retrieve details from a given file, in this case the file we just uploaded\n    let details_result = imagekit.upload(opts).await.unwrap();\n\n    // Delete a file\n    let delete_result = imagekit.delete(upload_result.file_id).await;\n}\n```\n\n## Features\n\nThe main goal of this crate is to support the main three functionalities\nprovided by ImageKit. URL Generation, File Upload and File Management.\n\nThe following list, provides a closer view to supported features and planned\nfeatures which are not yet implemented. Feel free to contribute by opening\nan issue, pull request or discussion.\n\n- [x] URL Generation\n  - [x] Basic Image Resizing\n  - [ ] Crop, Crop Modes and Focus\n  - [ ] Commonly Used Transformations\n- [ ] Signed URL Generation\n- [x] File Upload ([File Upload API][2])\n  - [x] From `tokio::fs::File` (Binary)\n  - [ ] From `std::fs::File` (Binary)\n  - [ ] From URL\n  - [ ] From Base64\n- [ ] File Management\n  - [ ] List Files\n  - [ ] Search Files\n  - [x] Get File Details\n  - [ ] Get File Versions\n  - [ ] Get File Metadata\n  - [ ] Custom Metadata Fields\n    - [ ] Create\n    - [ ] List\n    - [ ] Update\n    - [ ] Delete\n  - [x] Delete File\n  - [ ] Update File Details\n  - [ ] Tags\n    - [ ] Bulk Addition\n    - [ ] Bulk Deletion\n  - [ ] AI Tags\n    - [ ] Bulk Deletion\n  - [ ] Delete File Version\n  - [ ] Bulk Delete Files\n  - [ ] Copy File\n  - [ ] Move File\n  - [ ] Rename File\n  - [ ] Restore File Version\n  - [ ] Folders\n    - [ ] Create\n    - [ ] Copy\n    - [ ] Delete\n    - [ ] Move\n  - [ ] Bulk Job Status\n  - [ ] Cache\n   - [ ] Purge\n\n\u003e If you notice theres missing features in this list, please open an issue or PR.\n\n## Release\n\nIn order to create a release you must push a Git tag as follows\n\n```sh\ngit tag -a \u003cversion\u003e -m \u003cmessage\u003e\n```\n\n**Example**\n\n```sh\ngit tag -a v0.1.0 -m \"First release\"\n```\n\n\u003e Tags must follow semver conventions\n\u003e Tags must be prefixed with a lowercase `v` letter.\n\nThen push tags as follows:\n\n```sh\ngit push origin main --follow-tags\n```\n\n## Contributing\n\nEvery contribution to this project is welcome. Feel free to open a pull request,\nan issue or just by starting this project.\n\n## License\n\nAs most Rust projects, this crate is licensed under both, the Apache License\nand the MIT License.\n\n[1]: https://imagekit.io/dashboard/developer/api-keys\n[2]: https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhizzes%2Fimagekit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhizzes%2Fimagekit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhizzes%2Fimagekit/lists"}