Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 4.58 KB

README.md

File metadata and controls

121 lines (83 loc) · 4.58 KB

SSB Sirius Dash

PyPI Status Python Version License

Documentation Tests Coverage Quality Gate Status

pre-commit Black Ruff Poetry

Vennligst se komme i gang for brukerveiledning

The getting started guide is in norwegian and intended for Statistics Norway internal use.

More technical and in-depth information can be found in the Contributor Guide.

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-sirius-dash

or using poetry:

poetry add ssb-sirius-dash

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-sirius-dash --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 add this to your pyproject.toml:

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

Then run this command, optionally with --allow-prereleases to ensure you get the latest version.

poetry add --source testpypi ssb-sirius-dash --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.