| Name | mgallery JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | a cli tool to create gallery out of txt and png/jpeg files |
| upload_time | 2024-06-18 07:36:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2024 Roopkumar Das 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 |
gallery
image to webpage
twitter like gallery
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
pillow
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mgallery: A CLI Tool for Creating Static HTML Galleries
## Overview
mgallery is a command-line interface (CLI) tool that helps you create static HTML galleries from your images and text files. With mgallery, you can easily combine your files into a single HTML file, to view your gallery. It has similar style to twitter tweets.
## Installation
```
pip install mgallery
```
## Features
- Combine images (PNG, JPEG) and text files into a single HTML file
- Add or replace note metadata of images with a given note
- Read note metadata of images
- Supports multiple input files and directories
## Usage:
### Compile Command
Compile images and text files into a single HTML file:
```
mgallery compile <input_files> [-o output_file]
```
#### Example:
Let's say my diary directory is structured like this:
```
.
├── june
│ ├── 01-06-24.txt
│ ├── 04-06-24.txt
│ ├── buildspace_s5_w0.png
│ ├── IMG_20240616_191552.jpg
│ └── maybe_future_pp.jpg
└── may
├── 25-05-24.txt
├── 26-05-24.txt
```
To compile all text and image files without any exclusions, use:
```
mgallery compile -o /tmp/output.html
```
If `input_files` is not specified, the current working directory files will be used as input.
To compile only selected files, use:
```
mgallery compile june/maybe_future_pp.jpg june/01-06-24.txt -o /tmp/output.html
```
To compile files from a directory and a selected file from another directory, use:
```
mgallery compile june may/25-05-24.txt -o /tmp/output.html
```
The `-o` or `--output` flag specifies the location of the output file. If not provided, the CLI will create `output.html` in the current working directory.
### Note Command
Add or replace note metadata of an image with a given note:
```
mgallery note <image_filename> <note>
```
### Read Command
Read note metadata of an image:
```
mgallery read <image_filename>
```
## License
mgallery is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## Acknowledgments
I would like to thank the following projects and libraries that helped me create mgallery:
- vercel v0
- Groq LLaMA 70b
- Tailwind
- Pillow (PIL)
- Python standard libraries
## Issues
If you encounter any issues or have feedback, please open an issue in this repository.
I hope this helps! Let me know if you need any further modifications.
Raw data
{
"_id": null,
"home_page": null,
"name": "mgallery",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "gallery, image to webpage, twitter like gallery",
"author": null,
"author_email": "Roopkumar Das <roopkumards@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/50/37/2da611ee6dbaa9c384bf25fe37ae83006999c110f6f76eb7560741bf170e/mgallery-0.1.1.tar.gz",
"platform": null,
"description": "# mgallery: A CLI Tool for Creating Static HTML Galleries\n\n## Overview\n\nmgallery is a command-line interface (CLI) tool that helps you create static HTML galleries from your images and text files. With mgallery, you can easily combine your files into a single HTML file, to view your gallery. It has similar style to twitter tweets.\n\n## Installation\n\n```\npip install mgallery\n```\n\n## Features\n\n- Combine images (PNG, JPEG) and text files into a single HTML file\n- Add or replace note metadata of images with a given note\n- Read note metadata of images\n- Supports multiple input files and directories\n\n## Usage:\n\n### Compile Command\n\nCompile images and text files into a single HTML file:\n\n```\nmgallery compile <input_files> [-o output_file]\n```\n\n#### Example:\n\nLet's say my diary directory is structured like this:\n\n```\n.\n\u251c\u2500\u2500 june\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 01-06-24.txt\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 04-06-24.txt\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 buildspace_s5_w0.png\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 IMG_20240616_191552.jpg\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 maybe_future_pp.jpg\n\u2514\u2500\u2500 may\n \u251c\u2500\u2500 25-05-24.txt\n \u251c\u2500\u2500 26-05-24.txt\n```\n\nTo compile all text and image files without any exclusions, use:\n\n```\nmgallery compile -o /tmp/output.html\n```\n\nIf `input_files` is not specified, the current working directory files will be used as input.\n\nTo compile only selected files, use:\n\n```\nmgallery compile june/maybe_future_pp.jpg june/01-06-24.txt -o /tmp/output.html\n```\n\nTo compile files from a directory and a selected file from another directory, use:\n\n```\nmgallery compile june may/25-05-24.txt -o /tmp/output.html\n```\n\nThe `-o` or `--output` flag specifies the location of the output file. If not provided, the CLI will create `output.html` in the current working directory.\n\n### Note Command\n\nAdd or replace note metadata of an image with a given note:\n```\nmgallery note <image_filename> <note>\n```\n\n### Read Command\n\nRead note metadata of an image:\n```\nmgallery read <image_filename>\n```\n\n## License\n\nmgallery is licensed under the [MIT License](https://opensource.org/licenses/MIT).\n\n## Acknowledgments\n\nI would like to thank the following projects and libraries that helped me create mgallery:\n\n- vercel v0\n- Groq LLaMA 70b\n- Tailwind\n- Pillow (PIL)\n- Python standard libraries\n\n## Issues\n\nIf you encounter any issues or have feedback, please open an issue in this repository.\n\nI hope this helps! Let me know if you need any further modifications.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Roopkumar Das 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 tool to create gallery out of txt and png/jpeg files",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/RoopkumarD/mgallery",
"Issues": "https://github.com/RoopkumarD/mgallery/issues",
"Repository": "https://github.com/RoopkumarD/mgallery"
},
"split_keywords": [
"gallery",
" image to webpage",
" twitter like gallery"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a089a6745341229243b21bd58cee56feba663515ee92a22d8efcd774d3920654",
"md5": "df5fbac074bb106d0d9301c041881996",
"sha256": "4ecf86a6d2bb7278838534ddcc7bfec7c7c86be34cc25b34c8d6e233c294b6b7"
},
"downloads": -1,
"filename": "mgallery-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df5fbac074bb106d0d9301c041881996",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 115688,
"upload_time": "2024-06-18T07:36:19",
"upload_time_iso_8601": "2024-06-18T07:36:19.261230Z",
"url": "https://files.pythonhosted.org/packages/a0/89/a6745341229243b21bd58cee56feba663515ee92a22d8efcd774d3920654/mgallery-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50372da611ee6dbaa9c384bf25fe37ae83006999c110f6f76eb7560741bf170e",
"md5": "14f3ae6af39da658c9f296b8841c3b13",
"sha256": "0e51cea1114167e28ef7a2e20d9193923deba3c5146158ecca14dec14b288823"
},
"downloads": -1,
"filename": "mgallery-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "14f3ae6af39da658c9f296b8841c3b13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 116011,
"upload_time": "2024-06-18T07:36:20",
"upload_time_iso_8601": "2024-06-18T07:36:20.627770Z",
"url": "https://files.pythonhosted.org/packages/50/37/2da611ee6dbaa9c384bf25fe37ae83006999c110f6f76eb7560741bf170e/mgallery-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-18 07:36:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RoopkumarD",
"github_project": "mgallery",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pillow",
"specs": [
[
">=",
"8.3.0"
]
]
}
],
"lcname": "mgallery"
}
