Document dataset metadata. For use in Statistics Norway's metadata system.
Project description
Datadoc
Document datasets in Statistics Norway
Usage example
- Run
from datadoc import main; main("./path/to/your/dataset")
to run Datadoc on a dataset of your choosing. - Complete metadata as you desire
- Click
Lagre
to save a metadata document together with your dataset
If the datadoc package is not installed
- Clone this repo to your Jupyter instance (or local machine)
- Open the
DataDoc.ipynb
Notebook and run the cell to see the example dataset
Contributing
Dependency Management
Poetry is used for dependency management.
To install all required dependencies in a virtual environment run poetry install
. To add a new dependency to the project run poetry add <package name>
.
Run project locally in Jupyter
To run the project locally in Jupyter run:
poetry install
poetry run jupyter lab
A Jupyter instance should open in your browser. Once there, open the *.ipynb
file. Before running it, select the correct interpreter via Kernel > Change Kernel > datadoc
.
Run tests
- Install dev dependencies (see Dependency Management)
- Run
poetry shell
to open a shell in the Virtual Environment for the project - Run
pytest
in the root of the project
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ssb-datadoc-0.1.3.tar.gz
(41.1 kB
view hashes)
Built Distribution
Close
Hashes for ssb_datadoc-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | beca9980491aa9f423fe6db5dfc8b0cd5505e565a70fb3fb07e28229d0fddeb5 |
|
MD5 | d279b19b6bb1bba501eff7da3f8a23f6 |
|
BLAKE2b-256 | ff2b1257666a6aa0af19f417d3d06733809d75747bdf34f783e49f0132399cb2 |