ssb-altinn3-util


Namessb-altinn3-util JSON
Version 0.0.61 PyPI version JSON
download
home_pageNone
SummaryA small library package containing various tools and utilities
upload_time2024-11-27 10:00:35
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ssb-altinn3-util
A library of handy modules and utilities that can be used and built on when integrating with Altinn 3 and SSB's Altinn 3 data collection solutions

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-altinn3-util&metric=alert_status&token=1929d7efca8af99dc89ed16e2c68d6c80cc5c1ba)](https://sonarcloud.io/summary/new_code?id=statisticsnorway_ssb-altinn3-util)

## To build package locally during development run (from root directory of project):

python setup.py install

## Testing from other Python apps

- Push the changes to a branch of `ssb-altinn3-util`
- Uninstall previous ssb-altinn3-util in the app: `pip uninstall ssb-altinn3-util`
- Add the following in your requirements.txt in the app `git+ssh://git@github.com/statisticsnorway/ssb-altinn3-util@<your_branch_name>

After the testing is finished, remember to revert the `requirements.txt` before pushing the changes!

## Releasing to Artifact Registry

- Update version in `pyproject.toml`
- Create a GitHub release and the pipeline will push the package to Google Artifact Registry

## Running tests locally

In order to run the unittests locally things must be set up properly:
- In the project root directory run:

       pip install -e .
       pip install -r ./test/requirements-test.txt 
       
- This will install the package locally as editable (changes in code will immediately be reflected in the package) as well as the required dependencies.
- You should now be able to run the tests by running pytest from project root.

## Testing locally from another module

In order to test a new version from another module locally you first have to uninstall the package:
- pip uninstall ssb-altinn3-util         
Then the package must be installed from local path
- pip install <path to ssb-altinn3-util root directory>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ssb-altinn3-util",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Anders Hagen <nhk@ssb.no>, Rannveig Aasen <rsa@ssb.no>, Lars-Roger Billings\u00f8 <lrb@ssb.no>",
    "download_url": "https://files.pythonhosted.org/packages/5b/1e/6c3d37b899f19c0697d37b83b02eab295653ae71e6aab5ce3c8e8b9715b7/ssb_altinn3_util-0.0.61.tar.gz",
    "platform": null,
    "description": "# ssb-altinn3-util\nA library of handy modules and utilities that can be used and built on when integrating with Altinn 3 and SSB's Altinn 3 data collection solutions\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-altinn3-util&metric=alert_status&token=1929d7efca8af99dc89ed16e2c68d6c80cc5c1ba)](https://sonarcloud.io/summary/new_code?id=statisticsnorway_ssb-altinn3-util)\n\n## To build package locally during development run (from root directory of project):\n\npython setup.py install\n\n## Testing from other Python apps\n\n- Push the changes to a branch of `ssb-altinn3-util`\n- Uninstall previous ssb-altinn3-util in the app: `pip uninstall ssb-altinn3-util`\n- Add the following in your requirements.txt in the app `git+ssh://git@github.com/statisticsnorway/ssb-altinn3-util@<your_branch_name>\n\nAfter the testing is finished, remember to revert the `requirements.txt` before pushing the changes!\n\n## Releasing to Artifact Registry\n\n- Update version in `pyproject.toml`\n- Create a GitHub release and the pipeline will push the package to Google Artifact Registry\n\n## Running tests locally\n\nIn order to run the unittests locally things must be set up properly:\n- In the project root directory run:\n\n       pip install -e .\n       pip install -r ./test/requirements-test.txt \n       \n- This will install the package locally as editable (changes in code will immediately be reflected in the package) as well as the required dependencies.\n- You should now be able to run the tests by running pytest from project root.\n\n## Testing locally from another module\n\nIn order to test a new version from another module locally you first have to uninstall the package:\n- pip uninstall ssb-altinn3-util         \nThen the package must be installed from local path\n- pip install <path to ssb-altinn3-util root directory>\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A small library package containing various tools and utilities",
    "version": "0.0.61",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "76ad157e82c4d47d1b2476218eeb8fe5744f656acf82a5171bdab5060d1a66c0",
                "md5": "7bc23497935e1738fd9231f63bfa6300",
                "sha256": "f2dcb3b3ab31df7a9b394fbad75a3e6418de0fb5591e0554496a0548a30d1842"
            },
            "downloads": -1,
            "filename": "ssb_altinn3_util-0.0.61-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7bc23497935e1738fd9231f63bfa6300",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 28951,
            "upload_time": "2024-11-27T10:00:34",
            "upload_time_iso_8601": "2024-11-27T10:00:34.328703Z",
            "url": "https://files.pythonhosted.org/packages/76/ad/157e82c4d47d1b2476218eeb8fe5744f656acf82a5171bdab5060d1a66c0/ssb_altinn3_util-0.0.61-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5b1e6c3d37b899f19c0697d37b83b02eab295653ae71e6aab5ce3c8e8b9715b7",
                "md5": "5a10ee34e6e392610a09e1791969ee40",
                "sha256": "67dd46b86cedd2fe40e5016ee1b71555de79b44ccf215b198ebe4ac3d240d528"
            },
            "downloads": -1,
            "filename": "ssb_altinn3_util-0.0.61.tar.gz",
            "has_sig": false,
            "md5_digest": "5a10ee34e6e392610a09e1791969ee40",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 22006,
            "upload_time": "2024-11-27T10:00:35",
            "upload_time_iso_8601": "2024-11-27T10:00:35.486458Z",
            "url": "https://files.pythonhosted.org/packages/5b/1e/6c3d37b899f19c0697d37b83b02eab295653ae71e6aab5ce3c8e8b9715b7/ssb_altinn3_util-0.0.61.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-27 10:00:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ssb-altinn3-util"
}
        
Elapsed time: 0.42767s