Skip to main content

SSB Altinn Form Tools

Project description

SSB Altinn Form Tools

PyPI Status Python Version License

Documentation Tests Coverage Quality Gate Status

pre-commit Black Ruff Poetry

Features

  • Tools for automatically handling forms from Altinn3
    • Transforms the data to the standard schema for SSBs editing framework
    • Ingests the data using SQLAlchemy og Parquedit.

Requirements

  • TODO

Installation

You can install SSB Altinn Form Tools via pip from PyPI:

pip install ssb-altinn-form-tools

Example

See docs/documentation for further information. Walkthrough provides a deeper guide through the example and how everything works.

import logging

logging.basicConfig(
    level=logging.DEBUG,  # Set minimum log level
    format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
    force=True,
)

from sqlalchemy import create_engine
from ssb_altinn_form_tools.default_form_processor import DefaultFormProcessor
from ssb_altinn_form_tools.default_form_extractor import DefaultFormExtractor
from ssb_altinn_form_tools.sqlalchemy_storage_connector import (
    SqlAlchemyStorageConnector,
)

extractor = DefaultFormExtractor()

engine = engine = create_engine("sqlite:///./db.db", echo=False)
connector = SqlAlchemyStorageConnector(engine)
for form_number in ["RA0187", "RA0297", "RA0307", "RA0366", "RA0479", "RA0481", "RA0530", "RA0536", "RA0689", "RA0745", "RA0825"]:
    processor = DefaultFormProcessor(
        form_name=form_number,
        form_base_path=f"/home/onyxia/work/ssb-altinn-form-tools/tests/testdata/{form_number}",
        extractor=extractor,
        connector=connector,
        alias_mapping={"omsVirksomhetPerioden": "omsetning"},
    )
    processor.process_new_forms()

from sqlalchemy import text

with engine.connect() as conn:
    tables = conn.execute(text("SELECT name FROM sqlite_master WHERE type='table';")).fetchall()
    print("Tables:", tables)

with engine.connect() as conn:
    rows = conn.execute(text("SELECT * FROM enheter LIMIT 10;")).mappings().all()
    for row in rows:
        print(dict(row))

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, SSB Altinn Form Tools 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssb_altinn_form_tools-0.0.6.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssb_altinn_form_tools-0.0.6-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

Details for the file ssb_altinn_form_tools-0.0.6.tar.gz.

File metadata

  • Download URL: ssb_altinn_form_tools-0.0.6.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ssb_altinn_form_tools-0.0.6.tar.gz
Algorithm Hash digest
SHA256 99c6de49512803068889f3172e820c22d4cfe86736b6ba493ac5b7048ef9ef5a
MD5 7f8c987d5611c9705033830bb58fe2d4
BLAKE2b-256 b395627970fb348673cab6aea50b26823787e01213a887c147badbe5d922d084

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssb_altinn_form_tools-0.0.6.tar.gz:

Publisher: release.yml on statisticsnorway/ssb-altinn-form-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ssb_altinn_form_tools-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for ssb_altinn_form_tools-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3e320e86cc01061d5a9a1f34c67da36b5abb79f8baac14fa1db1c8c9c7df8822
MD5 3b335c47fc849eba10751d436b3b44e2
BLAKE2b-256 6685d01efdf8b1e44c65e5e59631af9a74727a18cc3f6b32fecdfca5f7451360

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssb_altinn_form_tools-0.0.6-py3-none-any.whl:

Publisher: release.yml on statisticsnorway/ssb-altinn-form-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page