| Name | ciofcheck JSON |
| Version |
0.1.13
JSON |
| download |
| home_page | None |
| Summary | A tool for checking and analyzing image sequences |
| upload_time | 2024-12-17 23:01:49 |
| maintainer | None |
| docs_url | None |
| author | Julian Mann |
| requires_python | ==3.11.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ciofcheck
A command-line tool for analyzing and validating image sequences. Easily check for missing frames, verify file sizes, and visualize sequence patterns.
## Installation
Install directly from PyPI:
```bash
pip install ciofcheck
```
## Usage
Basic usage:
```bash
ciofcheck "myfile[1-100####].png"
```
The pattern syntax supports:
- Frame ranges: `[1-100####]`
- Individual frames: `[1,5,10####]`
- Mixed specifications: `[1,5,10-20####]`
### Options
```bash
ciofcheck --help
```
### Display Options
1. **Summary** (default)
```bash
ciofcheck "myfile[1-100####].png"
```
Shows basic statistics about the sequence including missing frames and file sizes.
2. **ASCII Chart**
```bash
ciofcheck "myfile[1-100####].png" --display ascii
```
Displays a text-based visualization of file sizes.
3. **Bar Chart**
```bash
ciofcheck "myfile[1-100####].png" --display bar
```
Opens an interactive bar chart visualization.
## Examples
Check a sequence of PNG files:
```bash
ciofcheck "render[1-100####].png"
```
Analyze specific frames:
```bash
ciofcheck "shot[1,5,10-20####].exr"
```
View as ASCII chart with custom width:
```bash
ciofcheck "frame[1-50###].jpg" --display ascii --width 120
```
## Contributing
Contributions are welcome! Here's how you can help:
1. Fork the repository
2. Create a new branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run the tests (`poetry run pytest`)
5. Commit your changes (`git commit -m 'Add amazing feature'`)
6. Push to the branch (`git push origin feature/amazing-feature`)
7. Open a Pull Request
### Development Setup
1. Clone the repository:
```bash
git clone https://github.com/conductorTechnologies/ciofcheck.git
cd ciofcheck
```
2. Install Poetry if you haven't already:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```
3. Install dependencies:
```bash
poetry install
```
4. Activate the virtual environment:
```bash
poetry shell
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Authors
- Julian Mann - Initial work - [Julian Mann](https://github.com/hoolymama)
Raw data
{
"_id": null,
"home_page": null,
"name": "ciofcheck",
"maintainer": null,
"docs_url": null,
"requires_python": "==3.11.9",
"maintainer_email": null,
"keywords": null,
"author": "Julian Mann",
"author_email": "jmann@coreweave.com",
"download_url": "https://files.pythonhosted.org/packages/ea/94/732b7d7a9b1f74ebd8b7ca006a4a4655794e50409986c1306d3ca985dca6/ciofcheck-0.1.13.tar.gz",
"platform": null,
"description": "# ciofcheck\n\nA command-line tool for analyzing and validating image sequences. Easily check for missing frames, verify file sizes, and visualize sequence patterns.\n\n## Installation\n\nInstall directly from PyPI:\n```bash\npip install ciofcheck\n```\n\n## Usage\n\nBasic usage:\n```bash\nciofcheck \"myfile[1-100####].png\"\n```\n\nThe pattern syntax supports:\n- Frame ranges: `[1-100####]`\n- Individual frames: `[1,5,10####]`\n- Mixed specifications: `[1,5,10-20####]`\n\n### Options\n\n```bash\nciofcheck --help\n```\n\n### Display Options\n\n1. **Summary** (default)\n ```bash\n ciofcheck \"myfile[1-100####].png\"\n ```\n Shows basic statistics about the sequence including missing frames and file sizes.\n\n2. **ASCII Chart**\n ```bash\n ciofcheck \"myfile[1-100####].png\" --display ascii\n ```\n Displays a text-based visualization of file sizes.\n\n3. **Bar Chart**\n ```bash\n ciofcheck \"myfile[1-100####].png\" --display bar\n ```\n Opens an interactive bar chart visualization.\n\n## Examples\n\nCheck a sequence of PNG files:\n```bash\nciofcheck \"render[1-100####].png\"\n```\n\nAnalyze specific frames:\n```bash\nciofcheck \"shot[1,5,10-20####].exr\"\n```\n\nView as ASCII chart with custom width:\n```bash\nciofcheck \"frame[1-50###].jpg\" --display ascii --width 120\n```\n\n## Contributing\n\nContributions are welcome! Here's how you can help:\n\n1. Fork the repository\n2. Create a new branch (`git checkout -b feature/amazing-feature`)\n3. Make your changes\n4. Run the tests (`poetry run pytest`)\n5. Commit your changes (`git commit -m 'Add amazing feature'`)\n6. Push to the branch (`git push origin feature/amazing-feature`)\n7. Open a Pull Request\n\n### Development Setup\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/conductorTechnologies/ciofcheck.git\n cd ciofcheck\n ```\n\n2. Install Poetry if you haven't already:\n ```bash\n curl -sSL https://install.python-poetry.org | python3 -\n ```\n\n3. Install dependencies:\n ```bash\n poetry install\n ```\n\n4. Activate the virtual environment:\n ```bash\n poetry shell\n ```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Authors\n\n- Julian Mann - Initial work - [Julian Mann](https://github.com/hoolymama)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool for checking and analyzing image sequences",
"version": "0.1.13",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0008e96bb5ffbc8da022f42729e5b7c7f5fe460739ee7f3896e303f6467aeae9",
"md5": "f5adf402141477eeb7bdda771afa3303",
"sha256": "49d2fb83088b3db1a2c5e888bd0bdc9cb4436b7c882471e7eabdc07b8cec80a5"
},
"downloads": -1,
"filename": "ciofcheck-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5adf402141477eeb7bdda771afa3303",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "==3.11.9",
"size": 12499,
"upload_time": "2024-12-17T23:01:47",
"upload_time_iso_8601": "2024-12-17T23:01:47.522984Z",
"url": "https://files.pythonhosted.org/packages/00/08/e96bb5ffbc8da022f42729e5b7c7f5fe460739ee7f3896e303f6467aeae9/ciofcheck-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea94732b7d7a9b1f74ebd8b7ca006a4a4655794e50409986c1306d3ca985dca6",
"md5": "eeee68d722ccf6c96cf9fa8c5243cb42",
"sha256": "771a82b6c16f47e92045abd723b4a71eba75e87689853c89239eca43144b2ad9"
},
"downloads": -1,
"filename": "ciofcheck-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "eeee68d722ccf6c96cf9fa8c5243cb42",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==3.11.9",
"size": 11514,
"upload_time": "2024-12-17T23:01:49",
"upload_time_iso_8601": "2024-12-17T23:01:49.531945Z",
"url": "https://files.pythonhosted.org/packages/ea/94/732b7d7a9b1f74ebd8b7ca006a4a4655794e50409986c1306d3ca985dca6/ciofcheck-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 23:01:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ciofcheck"
}
