| Name | latex-clean-fig JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A CLI tool to clean unused figure files in LaTeX projects |
| upload_time | 2025-01-12 11:17:28 |
| maintainer | None |
| docs_url | None |
| author | Iztok Fister Jr. |
| requires_python | <4.0,>=3.13 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# latex-clean-fig
## Motivation
The package provides a simple command-line tool to help authors clean up unused image files in a project directory before submitting a paper. Multiple versions of figures often accumulate in the folder during the writing process, making it cluttered and difficult to manage. This tool scans the LaTeX file for figures included using the \includegraphics command and compares them against the image files in the specified folder. It identifies unused images and removes them, leaving only the files referenced in the LaTeX document. This is especially useful for ensuring the project directory remains tidy and submission-ready.
## 📦 Installation
### pip
Install latex-clean-fig with pip:
```sh
pip install latex-clean-fig
```
### How to use?
```sh
clean-fig TEX_FILE FOLDER
```
where:
- TEX_FILE: Path to your LaTeX file.
- FOLDER: Path to the folder containing image files.
This will scan TEX_FILE for included figures and remove any unused image files from the FOLDER directory.
## 🔑 License
This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.
## Disclaimer
This package is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!
Raw data
{
"_id": null,
"home_page": null,
"name": "latex-clean-fig",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.13",
"maintainer_email": null,
"keywords": null,
"author": "Iztok Fister Jr.",
"author_email": "iztok@iztok.dev",
"download_url": "https://files.pythonhosted.org/packages/49/6c/2370863cf87b1120a3584931d77b7f7f866992c7c5a4f1063af5d27e4ead/latex_clean_fig-0.1.0.tar.gz",
"platform": null,
"description": "# latex-clean-fig\n\n## Motivation\n\nThe package provides a simple command-line tool to help authors clean up unused image files in a project directory before submitting a paper. Multiple versions of figures often accumulate in the folder during the writing process, making it cluttered and difficult to manage. This tool scans the LaTeX file for figures included using the \\includegraphics command and compares them against the image files in the specified folder. It identifies unused images and removes them, leaving only the files referenced in the LaTeX document. This is especially useful for ensuring the project directory remains tidy and submission-ready.\n\n## \ud83d\udce6 Installation\n\n### pip\n\nInstall latex-clean-fig with pip:\n\n```sh\npip install latex-clean-fig\n```\n\n### How to use?\n\n```sh\nclean-fig TEX_FILE FOLDER\n```\nwhere:\n\n- TEX_FILE: Path to your LaTeX file.\n- FOLDER: Path to the folder containing image files.\n\nThis will scan TEX_FILE for included figures and remove any unused image files from the FOLDER directory.\n\n## \ud83d\udd11 License\n\nThis package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.\n\n## Disclaimer\n\nThis package is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool to clean unused figure files in LaTeX projects",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26f3e321e3dae9e5af1d4a479788fdd84592f284e567ee4b5972db1f1ed8d3ab",
"md5": "6b564d02025ca0c8e4151b388f82c361",
"sha256": "4c3ef1145c8761a4a842bdd04d5ae5e4d469f43bc60a3b6510fdc721bde56ab1"
},
"downloads": -1,
"filename": "latex_clean_fig-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b564d02025ca0c8e4151b388f82c361",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.13",
"size": 4174,
"upload_time": "2025-01-12T11:17:24",
"upload_time_iso_8601": "2025-01-12T11:17:24.695943Z",
"url": "https://files.pythonhosted.org/packages/26/f3/e321e3dae9e5af1d4a479788fdd84592f284e567ee4b5972db1f1ed8d3ab/latex_clean_fig-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "496c2370863cf87b1120a3584931d77b7f7f866992c7c5a4f1063af5d27e4ead",
"md5": "600059c2e280296a0a809539363020a0",
"sha256": "46b6624ca22707eed25863733102ffab9799a084c499779a19600af6ad2a5513"
},
"downloads": -1,
"filename": "latex_clean_fig-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "600059c2e280296a0a809539363020a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.13",
"size": 3166,
"upload_time": "2025-01-12T11:17:28",
"upload_time_iso_8601": "2025-01-12T11:17:28.335273Z",
"url": "https://files.pythonhosted.org/packages/49/6c/2370863cf87b1120a3584931d77b7f7f866992c7c5a4f1063af5d27e4ead/latex_clean_fig-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-12 11:17:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "latex-clean-fig"
}
