Skip to main content

Modular Python tool for profiling files, analyzing directory structures, and inspecting image data

Project description

filoma

PyPI version Code style: ruff Contributions welcome Tests

filoma is a modular Python tool for profiling files, analyzing directory structures, and inspecting image data (e.g., .tif, .png, .npy, .zarr). It provides detailed reports on filename patterns, inconsistencies, file counts, empty folders, file system metadata, and image data statistics. The project is designed for easy expansion, testing, CI/CD, Dockerization, and database integration.

Features

  • Directory analysis: Filename pattern extraction, reporting, statistics, empty folder detection
  • Image analysis: Analyze .tif, .png, .npy, .zarr files for metadata, stats (min, max, mean, NaNs, etc.), and irregularities
  • File profiling: System metadata (size, permissions, owner, group, timestamps, symlink targets, etc.)
  • Modular, extensible codebase
  • CLI entry point (planned)
  • Ready for testing, CI/CD, Docker, and database integration

Simple Examples

File Profiling

from filoma.fileinfo import FileProfiler
profiler = FileProfiler()
report = profiler.profile("/path/to/file.txt")
profiler.print_report(report)  # Rich table output in your terminal
# Output: (Rich table with file metadata and access rights)

Image Analysis

from filoma.img import PngChecker
checker = PngChecker()
report = checker.check("/path/to/image.png")
print(report)
# Output: {'shape': ..., 'dtype': ..., 'min': ..., 'max': ..., 'nans': ..., ...}

Project Structure

  • src/filoma/img/ — Image checkers and analysis
  • src/filoma/fileprof/ — File profiling (system metadata)
  • tests/ — Unit tests for all modules

Future TODO

  • CLI tool for all features
  • Directory pattern and statistics module
  • More image format support and advanced checks
  • Database integration for storing reports
  • Dockerization and deployment guides
  • CI/CD workflows and badges

filoma is under active development. Contributions and suggestions are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

filoma-0.1.3.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

filoma-0.1.3-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file filoma-0.1.3.tar.gz.

File metadata

  • Download URL: filoma-0.1.3.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for filoma-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e0018e60aa20b505326154b9216565e093df40a4aa65032ba9128655dcf2d6fb
MD5 a8c3b1e0d28e26f75447bf1029cb0af0
BLAKE2b-256 b5d7def37eed618533e3af0b35e218d3822616b3b1a4a0844b879bf8b789526a

See more details on using hashes here.

Provenance

The following attestation bundles were made for filoma-0.1.3.tar.gz:

Publisher: publish.yml on kalfasyan/filoma

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file filoma-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: filoma-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for filoma-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 21886bbece61fd1b393975dbc4fad0b949202e8cd84ecb3ef9c08f17b2480533
MD5 3a40148a0f436fd109a5548ac82374f0
BLAKE2b-256 c9742bd636880d93d503512af14e74c3a1f54e6574e9f98f9b27c0c4657a96e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for filoma-0.1.3-py3-none-any.whl:

Publisher: publish.yml on kalfasyan/filoma

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page