ssb-datadoc

Name	ssb-datadoc JSON
Version	1.0.8 JSON
	download
home_page	https://github.com/statisticsnorway/datadoc-editor
Summary	Document dataset metadata. For use in Statistics Norway's metadata system.
upload_time	2024-12-03 08:23:34
maintainer	None
docs_url	None
author	Statistics Norway
requires_python	<4.0,>=3.10
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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/

<!-- 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


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/statisticsnorway/datadoc-editor",
    "name": "ssb-datadoc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Statistics Norway",
    "author_email": "stat-dev@ssb.no",
    "download_url": "https://files.pythonhosted.org/packages/16/b1/21d23181d4e60e3f6dbaa936a43903407bbf8aca1b6742cd539482ed37f4/ssb_datadoc-1.0.8.tar.gz",
    "platform": null,
    "description": "# Datadoc\n\n[![PyPI](https://img.shields.io/pypi/v/ssb-datadoc.svg)][pypi status]\n[![Status](https://img.shields.io/pypi/status/ssb-datadoc.svg)][pypi status]\n[![Python Version](https://img.shields.io/pypi/pyversions/ssb-datadoc)][pypi status]\n[![License](https://img.shields.io/pypi/l/ssb-datadoc)][license]\n\n[![Documentation](https://github.com/statisticsnorway/datadoc/actions/workflows/docs.yml/badge.svg)][documentation]\n[![Tests](https://github.com/statisticsnorway/datadoc/actions/workflows/tests.yml/badge.svg)][tests]\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_datadoc&metric=coverage)][sonarcov]\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_datadoc&metric=alert_status)][sonarquality]\n\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]\n[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]\n[![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)\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]\n\n[pypi status]: https://pypi.org/project/ssb-datadoc/\n[documentation]: https://statisticsnorway.github.io/datadoc\n[tests]: https://github.com/statisticsnorway/datadoc/actions?workflow=Tests\n\n[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_datadoc\n[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_datadoc\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n[poetry]: https://python-poetry.org/\n\n## Features\n\n- Describe a dataset and its variables according to Statistics Norway's metadata model.\n- Supports `parquet` and `sas7bdat` dataset files.\n- Supports local file system and Google Cloud Storage buckets.\n\n## Installation\n\nYou can install _Datadoc_ via [pipx] from [PyPI]:\n\n```console\npipx install ssb-datadoc\n```\n\n## Usage\n\nDatadoc is available on [Dapla Lab](https://lab.dapla.ssb.no/) and works best there.\n\nUsage instructions: https://manual.dapla.ssb.no/statistikkere/datadoc.html\n\n## Contributing\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide].\n\n## License\n\nDistributed under the terms of the [MIT license][license],\n_Datadoc_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n## Credits\n\nThis project was generated from [Statistics Norway]'s [SSB PyPI Template].\n\n[statistics norway]: https://www.ssb.no/en\n[pypi]: https://pypi.org/\n[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate\n[file an issue]: https://github.com/statisticsnorway/datadoc/issues\n[pipx]: https://pipx.pypa.io/latest/installation/\n\n<!-- github-only -->\n\n[license]: https://github.com/statisticsnorway/datadoc/blob/main/LICENSE\n[contributor guide]: https://github.com/statisticsnorway/datadoc/blob/main/CONTRIBUTING.md\n[reference guide]: https://statisticsnorway.github.io/datadoc/reference.html\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Document dataset metadata. For use in Statistics Norway's metadata system.",
    "version": "1.0.8",
    "project_urls": {
        "Changelog": "https://github.com/statisticsnorway/datadoc-editor/releases",
        "Documentation": "https://statisticsnorway.github.io/datadoc-editor",
        "Homepage": "https://github.com/statisticsnorway/datadoc-editor",
        "Repository": "https://github.com/statisticsnorway/datadoc-editor"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac880f4b5861617dfc48f1d8e6c257bbfe4f424414e2d1b2b24b24eff3a14e6b",
                "md5": "d744d86ef37c543ea114ea4a24bc9d47",
                "sha256": "42f86287d90cf4e61b8cc407a515ef76fc9f38e84ff66c2793693278b3f994d1"
            },
            "downloads": -1,
            "filename": "ssb_datadoc-1.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d744d86ef37c543ea114ea4a24bc9d47",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 320242,
            "upload_time": "2024-12-03T08:23:32",
            "upload_time_iso_8601": "2024-12-03T08:23:32.355268Z",
            "url": "https://files.pythonhosted.org/packages/ac/88/0f4b5861617dfc48f1d8e6c257bbfe4f424414e2d1b2b24b24eff3a14e6b/ssb_datadoc-1.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "16b121d23181d4e60e3f6dbaa936a43903407bbf8aca1b6742cd539482ed37f4",
                "md5": "63fdbbd0217718e097b64a9efc2cbc1d",
                "sha256": "e66beb0a1e1ec1e27609047d87becea3f13f98b74688a1740959fe20648f52c4"
            },
            "downloads": -1,
            "filename": "ssb_datadoc-1.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "63fdbbd0217718e097b64a9efc2cbc1d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 311822,
            "upload_time": "2024-12-03T08:23:34",
            "upload_time_iso_8601": "2024-12-03T08:23:34.038469Z",
            "url": "https://files.pythonhosted.org/packages/16/b1/21d23181d4e60e3f6dbaa936a43903407bbf8aca1b6742cd539482ed37f4/ssb_datadoc-1.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-03 08:23:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "statisticsnorway",
    "github_project": "datadoc-editor",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ssb-datadoc"
}