ssb-datadoc 0.1.2

Document dataset metadata. For use in Statistics Norway's metadata system.

Datadoc

Document datasets in Statistics Norway

Usage example

1. Run from datadoc import main; main("./path/to/your/dataset") to run Datadoc on a dataset of your choosing.
2. Complete metadata as you desire
3. Click Lagre to save a metadata document together with your dataset

If the datadoc package is not installed

1. Clone this repo to your Jupyter instance (or local machine)
2. 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 shell
ipython kernel install --user --name="datadoc"
jupyter notebook

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

1. Install dev dependencies (see Dependency Management)
2. Run poetry shell to open a shell in the Virtual Environment for the project
3. Run pytest in the root of the project