Metadata-Version: 2.4
Name: dicogis
Version: 4.0.1
Summary: Create Excel spreadsheet describing geographical data from a PostGIS Database or a file tree structure.
Author-email: Julien Moura <dev@ingeoveritas.com>
License-Expression: Apache-2.0
Project-URL: Bug Reports, https://github.com/Guts/DicoGIS/issues/
Project-URL: Docs, https://guts.github.io/DicoGIS/
Project-URL: Homepage, https://github.com/Guts/DicoGIS/
Project-URL: Source, https://github.com/Guts/DicoGIS/
Keywords: GDAL,GIS,INSPIRE,OGR,data management,metadata
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: <4,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lxml<6.2,>=5.1
Requires-Dist: notify-py<0.4,>=0.3.42
Requires-Dist: numpy<2.6,>=2.0.2
Requires-Dist: openpyxl<3.2,>=3.0
Requires-Dist: pgserviceparser<4,>=3.0.3
Requires-Dist: requests<3,>=2.32.3
Requires-Dist: typer<1,>=0.24.1
Provides-Extra: dev
Requires-Dist: pre-commit<5,>=4.5; extra == "dev"
Requires-Dist: ruff<0.18.0,>=0.15.20; extra == "dev"
Provides-Extra: doc
Requires-Dist: furo>=2024; extra == "doc"
Requires-Dist: matplotlib<4,>=3.8; extra == "doc"
Requires-Dist: myst-parser[linkify]>=2; extra == "doc"
Requires-Dist: sphinx-autobuild>=2021; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints<3.7,>=2.2.2; extra == "doc"
Requires-Dist: sphinx-click>=5; extra == "doc"
Requires-Dist: sphinx-copybutton<1; extra == "doc"
Requires-Dist: sphinx-design<1,>=0.5; extra == "doc"
Requires-Dist: sphinx-sitemap<3,>=2.4; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid<3; extra == "doc"
Requires-Dist: sphinxext-opengraph>=0.9; extra == "doc"
Provides-Extra: gdal
Requires-Dist: gdal[numpy]<4,>=3.5.0; extra == "gdal"
Provides-Extra: gui
Requires-Dist: PyQt6<6.13,>=6.11; extra == "gui"
Provides-Extra: packaging
Requires-Dist: pyinstaller<6.23,>=6.8.0; extra == "packaging"
Requires-Dist: pypiwin32==223; sys_platform == "win32" and extra == "packaging"
Provides-Extra: test
Requires-Dist: packaging<27,>=20; extra == "test"
Requires-Dist: pytest-cov<8,>=4; extra == "test"
Requires-Dist: pytest-qt<5,>=4.4; extra == "test"
Requires-Dist: responses<0.27,>=0.25; extra == "test"
Requires-Dist: validators<0.37,>=0.29.0; extra == "test"
Dynamic: license-file

# DicoGIS

[![Build 📦 and release 🚀](https://github.com/Guts/DicoGIS/actions/workflows/builder_releaser.yml/badge.svg)](https://github.com/Guts/DicoGIS/actions/workflows/builder_releaser.yml)
[![Tester 🎳](https://github.com/Guts/DicoGIS/actions/workflows/tester.yml/badge.svg)](https://github.com/Guts/DicoGIS/actions/workflows/tester.yml)
[![📚 Documentation Builder](https://github.com/Guts/DicoGIS/actions/workflows/docs_builder.yml/badge.svg)](https://github.com/Guts/DicoGIS/actions/workflows/docs_builder.yml)
[![Build 🐳 and publish container image](https://github.com/Guts/DicoGIS/actions/workflows/docker_builder.yml/badge.svg)](https://github.com/Guts/DicoGIS/actions/workflows/docker_builder.yml)
[![codecov](https://codecov.io/gh/Guts/DicoGIS/branch/master/graph/badge.svg?token=phiBV8BfPA)](https://codecov.io/gh/Guts/DicoGIS)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Guts/DicoGIS/master.svg)](https://results.pre-commit.ci/latest/github/Guts/DicoGIS/master)

![GitHub all releases](https://img.shields.io/github/downloads/guts/dicogis/total)

Automatize the creation of a dictionnary of geographic data in a folders structure. The output dictionary is an Excel file (.xlsx).

For further information, see [the documentation](https://guts.github.io/DicoGIS/).

## Installation

DicoGIS relies on GDAL, declared as an optional dependency so that `pipx install dicogis` (or `pip install dicogis`) always succeeds, even without GDAL. Getting GDAL into a pipx-managed virtual environment needs a couple of extra steps depending on your OS. See the [pipx installation guide](https://guts.github.io/DicoGIS/usage/installation.html).

PyQt6, needed only for the `dicogis-gui` desktop app, is likewise an optional dependency (the `gui` extra): `pip install dicogis[gui]` / `pipx inject dicogis PyQt6`. `dicogis-cli` never needs it.

If you'd rather avoid Python/GDAL packaging altogether, standalone CLI/GUI executables (Windows and Ubuntu) that embed GDAL are published on the [latest release](https://github.com/Guts/DicoGIS/releases/latest), and a `dicogis-cli` container image (GDAL included) is published to the [GitHub Container Registry](https://github.com/Guts/DicoGIS/pkgs/container/dicogis):

```sh
docker run --rm -v "$(pwd)":/data ghcr.io/guts/dicogis:latest \
    inventory --input-folder /data --output-path /data/dicogis_inventory.xlsx
```
