Metadata-Version: 2.1
Name: ssb-datadoc
Version: 0.8.2
Summary: Document dataset metadata. For use in Statistics Norway's metadata system.
Home-page: https://github.com/statisticsnorway/datadoc
License: MIT
Author: Statistics Norway
Author-email: stat-dev@ssb.no
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Dash
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Dist: arrow (>=1.3.0)
Requires-Dist: beautifulsoup4 (>=4.12.3)
Requires-Dist: cloudpathlib[gs] (>=0.17.0)
Requires-Dist: dapla-toolbelt (>=1.3.3)
Requires-Dist: dash (>=2.15.0)
Requires-Dist: dash-bootstrap-components (>=1.1.0)
Requires-Dist: flask-healthz (>=0.0.3)
Requires-Dist: gunicorn (>=21.2.0)
Requires-Dist: pandas (>=1.4.2)
Requires-Dist: pyarrow (>=8.0.0)
Requires-Dist: pydantic (==2.5.2)
Requires-Dist: pyjwt (>=2.8.0)
Requires-Dist: python-dotenv (>=1.0.1)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: ssb-dash-components (>=0.5.2)
Requires-Dist: ssb-datadoc-model (==4.3.2)
Requires-Dist: ssb-klass-python (>=0.0.9)
Project-URL: Changelog, https://github.com/statisticsnorway/datadoc/releases
Project-URL: Documentation, https://statisticsnorway.github.io/datadoc
Project-URL: Repository, https://github.com/statisticsnorway/datadoc
Description-Content-Type: text/markdown

# Datadoc

[![PyPI](https://img.shields.io/pypi/v/ssb-datadoc.svg)][pypi status]
[![Status](https://img.shields.io/pypi/status/ssb-datadoc.svg)][pypi status]
[![Python Version](https://img.shields.io/pypi/pyversions/ssb-datadoc)][pypi status]
[![License](https://img.shields.io/pypi/l/ssb-datadoc)][license]

[![Documentation](https://github.com/statisticsnorway/datadoc/actions/workflows/docs.yml/badge.svg)][documentation]
[![Tests](https://github.com/statisticsnorway/datadoc/actions/workflows/tests.yml/badge.svg)][tests]
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_datadoc&metric=coverage)][sonarcov]
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_datadoc&metric=alert_status)][sonarquality]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
[![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)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]

[pypi status]: https://pypi.org/project/ssb-datadoc/
[documentation]: https://statisticsnorway.github.io/datadoc
[tests]: https://github.com/statisticsnorway/datadoc/actions?workflow=Tests

[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_datadoc
[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_datadoc
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
[poetry]: https://python-poetry.org/

## Features

- Describe a dataset and its variables according to Statistics Norway's metadata model.
- Supports `parquet` and `sas7bdat` dataset files.
- Supports local file system and Google Cloud Storage buckets.

## Installation

You can install _Datadoc_ via [pipx] from [PyPI]:

```console
pipx install ssb-datadoc
```

## Usage

Please see the [Reference Guide] for details.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
_Datadoc_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [Statistics Norway]'s [SSB PyPI Template].

[statistics norway]: https://www.ssb.no/en
[pypi]: https://pypi.org/
[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
[file an issue]: https://github.com/statisticsnorway/datadoc/issues
[pipx]: https://pipx.pypa.io/latest/installation/

<!-- github-only -->

[license]: https://github.com/statisticsnorway/datadoc/blob/main/LICENSE
[contributor guide]: https://github.com/statisticsnorway/datadoc/blob/main/CONTRIBUTING.md
[reference guide]: https://statisticsnorway.github.io/datadoc/reference.html

