SSB Dash Framework

Documentation

The documentation for this project can be found here or in the docs folder.

Features

• Dashboard for editing data, includes modules for among other things:
  • Controls for the data
  • Visualizations to find outliers
  • Seeing micro-level information about observations

Requirements

• TODO

Installation

You can install SSB Sirius Dash via pip from PyPI:

pip install ssb-dash-framework

or using poetry:

poetry add ssb-dash-framework

The above will install the latest stable release.

Installing the pre-release version

This version contains new features and improvements that are heading to the stable release eventually, but is still subject to changes.

poetry add ssb-dash-framework --allow-prereleases

Installing the development version

This is the currently in-development version. Be aware that this is a very unstable version and is subject to rapid breaking changes.

• Primarily intended for testing of in-development features.

First make sure this is in your pyproject.toml:

[[tool.poetry.source]]
name = "testpypi"
url = "https://test.pypi.org/simple"
priority = "supplemental"

It can be added manually or using the command below.

poetry source add --priority=supplemental testpypi https://test.pypi.org/simple

If it is in your pyproject.toml, run this command with --allow-prereleases to ensure you get the latest version.

poetry add --source testpypi ssb-dash-framework --allow-prereleases

Usage

Please see the Reference Guide for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

We are following the gitflow workflow, meaning that the main branch is the release version, while development happens on the develop branch. An explanation of how gitflow works can be found here: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

License

Distributed under the terms of the GNU license, SSB Sirius Dash 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.