Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/statisticsnorway/datadoc-editor
Document datasets in SSB
https://github.com/statisticsnorway/datadoc-editor
backstage dapla dash metadata pypi python
Last synced: 6 days ago
JSON representation
Document datasets in SSB
- Host: GitHub
- URL: https://github.com/statisticsnorway/datadoc-editor
- Owner: statisticsnorway
- License: mit
- Created: 2022-03-30T15:48:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-03T08:46:51.000Z (20 days ago)
- Last Synced: 2024-12-10T11:18:02.829Z (13 days ago)
- Topics: backstage, dapla, dash, metadata, pypi, python
- Language: Python
- Homepage: https://statisticsnorway.github.io/datadoc/
- Size: 5.78 MB
- Stars: 9
- Watchers: 17
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# 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
Datadoc is available on [Dapla Lab](https://lab.dapla.ssb.no/) and works best there.
Usage instructions: https://manual.dapla.ssb.no/statistikkere/datadoc.html
## 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/[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