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.2.tar.gz (22.9 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.2-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ssb_altinn_form_tools-0.0.2.tar.gz
  • Upload date:
  • Size: 22.9 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.2.tar.gz
Algorithm Hash digest
SHA256 98cbf9ca5cfba0aceb94809a0061af6cb56d421406937973dbcda44de5b80225
MD5 6317a1e178271ee2a28f6344ed919b31
BLAKE2b-256 5a799fe97297d6ed6ba0a38819a8f40e88f49a1099757577f27e5876c6352288

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssb_altinn_form_tools-0.0.2.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.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ssb_altinn_form_tools-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7f22218218cc3e2c9c1e0c323ee6f726aa0688be803f35f29b94eada91619df9
MD5 d72cc2514d9db76150566f46b6da05a7
BLAKE2b-256 76e537e0af4901951a69632d3bab19db83c6451e323753e7d90b8d3bfed933ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssb_altinn_form_tools-0.0.2-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