SSB Altinn Python
Project description
SSB Altinn Python
Features
This is work-in-progress Python-package for dealing with xml-data from Altinn3. Here are some examples of how it can be used:
Get information about a file
from altinn import FileInfo
file = "gs://ssb-prod-dapla-felles-data-delt/altinn3/RA-0595/2023/2/6/810409282_460784f978a2_ebc7af7e-4ebe-4883-b844-66ee6292a93a/form_460784f978a2.xml"
# Create an instance of FileInfo
form = FileInfo(file)
# Get file filename without '.xml'-postfix
form.filename()
# Returns: 'form_dc551844cd74'
# Print an unformatted version of the file. Does not require the file to be parseable by an xml-library. Useful for inspecting unvalid xml-files.
form.print()
# Print a nicely formatted version of the file
form.pretty_print()
# Check if xml-file is valid. Useful to inspect xml-files with formal errors in the xml-schema.
form.validate()
# Returns True og False
Parse xml-file
If you want to transform an Altinn3 xml-file to a Pandas Dataframe, you can use the ParseSingleXml-class.
from altinn import ParseSingleXml
file = "gs://ssb-prod-dapla-felles-data-delt/altinn3/RA-0595/2023/2/6/810409282_460784f978a2_ebc7af7e-4ebe-4883-b844-66ee6292a93a/form_460784f978a2.xml"
form_content=ParseSingleXml(file)
# Get a Pandas Dataframe representation of the contents of the file
df=form_content.to_dataframe()
df.head()
Transform to ISEE-Dynarev format
If you want to transform an Altinn3 xml-file to a Pandas Dataframe, in the same form as the ISEE Dynarev database in our on-prem environment, you can use the isee_transform
-function.
from altinn import isee_transform
file = "gs://ssb-prod-dapla-felles-data-delt/altinn3/RA-0595/2023/2/6/810409282_460784f978a2_ebc7af7e-4ebe-4883-b844-66ee6292a93a/form_460784f978a2.xml"
isee_transform(file)
If you want to recode/map names in the FELTNAVN-column, you can use a dictionary with the original names from the xml as keys, and the new names as values. And then pass the dictionary as an argument when running the function isee_transform(file, mapping).
from altinn import isee_transform
file = "gs://ssb-prod-dapla-felles-data-delt/altinn3/RA-0595/2023/2/6/810409282_460784f978a2_ebc7af7e-4ebe-4883-b844-66ee6292a93a/form_460784f978a2.xml"
mapping = {'kontAmbulForeDispJaNei':'ISEE_VAR1',
'kontAmbulForeDispAnt':'ISEE_VAR2',
'kontAmbulForeDriftAnt':'ISEE_VAR3',}
isee_transform(file, mapping)
The function handles flat structures and 'tables' in the XML. If the XML contains repeating values, it puts a suffix containig a number at the end of the FELTNAVN-column. If the XML-contains more complex structures as 'table in table' if will give a warning with a list of which values in FELTNAVN that needs to be further processed before it can be used in ISEE.
The XML needs to contain certain fields in the 'InternInfo'-block, The required filds are:
- 'enhetsIdent'
- 'enhetsType'
- 'delregNr'
If one or more of these fields are missing in the XML, the processing will stop, giving a message with witch fields that are missing.
The resulting object is a Pandas Dataframe with the following columns:
SKJEMA_ID
DELREG_NR
IDENT_NR
ENHETS_TYPE
FELTNAVN
FELTVERDI
VERSION_NR
This dataframe can be written to csv and uploaded to the ISEE Dynarev database.
Requirements
- dapla-toolbelt >=1.6.2
- defusedxml >=0.7.1
- xmltodict >=0.13.0
- pandas >= 2.2.0
Installation
You can install SSB Altinn Python via poetry from PyPI:
poetry add ssb-altinn-python
To install this in the Jupyter-environment on Dapla, where it is ment to be used, it is required to install it in an virtual environment. It is recommended to do this in an ssb-project where the preferred tool is poetry.
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 Python 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ssb_altinn_python-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c7e23bf348e74aa1ae6218b5a2d4990c40008984c4f6718d56bac98bf50c90d |
|
MD5 | 7d660e0f83d2d8f869dd88b29bd6aa07 |
|
BLAKE2b-256 | e1da6148213663ba6974449c078a0e093961ae067757fc214a2f7c1e721c389d |