# Datadoc
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[][documentation]
[][tests]
[][sonarcov]
[][sonarquality]
[][pre-commit]
[][black]
[](https://github.com/astral-sh/ruff)
[][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
Raw data
{
"_id": null,
"home_page": "https://github.com/statisticsnorway/datadoc",
"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/24/33/cce2c8265184c0afc41c532346441b4d35efb98ae49b08fda76d3e575b37/ssb_datadoc-0.12.0.tar.gz",
"platform": null,
"description": "# Datadoc\n\n[][pypi status]\n[][pypi status]\n[][pypi status]\n[][license]\n\n[][documentation]\n[][tests]\n[][sonarcov]\n[][sonarquality]\n\n[][pre-commit]\n[][black]\n[](https://github.com/astral-sh/ruff)\n[][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\nPlease see the [Reference Guide] for details.\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": "0.12.0",
"project_urls": {
"Changelog": "https://github.com/statisticsnorway/datadoc/releases",
"Documentation": "https://statisticsnorway.github.io/datadoc",
"Homepage": "https://github.com/statisticsnorway/datadoc",
"Repository": "https://github.com/statisticsnorway/datadoc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc06c67149c39a2a5f607ef026c53e20bca235ce5a1bbeaf446a53eb79b43dd0",
"md5": "4f21e930cc62ba9deec6c265f0e97844",
"sha256": "be9522d8313376493958f9e830595511cd3e2d1529adef476a98a5e0a880a046"
},
"downloads": -1,
"filename": "ssb_datadoc-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f21e930cc62ba9deec6c265f0e97844",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 334603,
"upload_time": "2024-05-08T06:46:33",
"upload_time_iso_8601": "2024-05-08T06:46:33.751409Z",
"url": "https://files.pythonhosted.org/packages/fc/06/c67149c39a2a5f607ef026c53e20bca235ce5a1bbeaf446a53eb79b43dd0/ssb_datadoc-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2433cce2c8265184c0afc41c532346441b4d35efb98ae49b08fda76d3e575b37",
"md5": "f7f13982b94e75bc617d8d2de391a4e1",
"sha256": "f39b59b8370782222138b9613aebda9ae4053c0a81a465984f8669c3a14a2187"
},
"downloads": -1,
"filename": "ssb_datadoc-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "f7f13982b94e75bc617d8d2de391a4e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 322261,
"upload_time": "2024-05-08T06:46:37",
"upload_time_iso_8601": "2024-05-08T06:46:37.868780Z",
"url": "https://files.pythonhosted.org/packages/24/33/cce2c8265184c0afc41c532346441b4d35efb98ae49b08fda76d3e575b37/ssb_datadoc-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 06:46:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "statisticsnorway",
"github_project": "datadoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ssb-datadoc"
}
JSON
