Skip to main content

A Python wrapper for the Brønnøysund Register Centre (Brreg) API.

Project description

🔥 Brreg Wrapper

PyPI version License: MIT Python Version

Tired of wrestling with raw API calls to the Brønnøysund Register Centre (Brreg)? brreg-wrapper is here to simplify your life! This sleek, asynchronous Python library provides an intuitive interface to access crucial Norwegian business information with ease.

Get details on main entities (enheter) and sub-entities (underenheter), perform searches, and integrate Norwegian business data into your applications effortlessly.

✨ Core Features

  • Asynchronous: Built with asyncio and httpx for modern, non-blocking I/O.
  • Type Hinted: Fully type-hinted for better developer experience and static analysis.
  • Pydantic Models: Uses Pydantic models for robust data validation and easy object access (where applicable).
  • Context Management: Supports async with for automatic HTTP client cleanup.
  • Comprehensive API Coverage: Wraps numerous endpoints from the official Brreg API.
  • Minimal Dependencies: Relies primarily on httpx and pydantic.

🚀 Installation

Get started in seconds:

pip install brreg-wrapper
# Or using uv:
uv add brreg-wrapper

💡 Usage Example

Here's a taste of how easy it is to fetch data:

import asyncio
import json
from brreg_wrapper import BrregClient

async def main():
    # The client automatically handles HTTP sessions
    async with BrregClient() as client:
        org_nr = "923609016" # Example: Equinor ASA

        print(f"🔍 Fetching details for organization number: {org_nr}")
        try:
            entity_info = await client.get_enhet(org_nr)
            print("\n--- Entity Details ---")
            # Pretty print the JSON response
            print(json.dumps(entity_info, indent=2, ensure_ascii=False))

            # Want to find sub-entities?
            # sub_entity_info = await client.get_underenhet("some_sub_org_nr")
            # print(json.dumps(sub_entity_info, indent=2, ensure_ascii=False))

        except Exception as e:
            print(f"\n💥 Oops! An error occurred: {e}")

        print("\n✅ Done!")

if __name__ == "__main__":
    asyncio.run(main())

🤝 Contributing

Contributions are welcome! If you have ideas for improvements or find a bug, please open an issue or submit a pull request on the GitHub repository.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Issues?

Having trouble? Found a bug? Feel free to open an issue on the GitHub repository.

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

brreg_wrapper-0.1.4.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

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

brreg_wrapper-0.1.4-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file brreg_wrapper-0.1.4.tar.gz.

File metadata

  • Download URL: brreg_wrapper-0.1.4.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for brreg_wrapper-0.1.4.tar.gz
Algorithm Hash digest
SHA256 28123a31ff8cf3b85be45a332393585fd22a4d4ca496b0bf065cebe8e56bf181
MD5 87d359c4184b5bfb3286e983343da8c4
BLAKE2b-256 c9d9a6e96822ae306d9af0fbbb9aa512b747f21d850d9caa4dd23e9e290ab100

See more details on using hashes here.

Provenance

The following attestation bundles were made for brreg_wrapper-0.1.4.tar.gz:

Publisher: publish-to-pypi.yml on sondreal/brreg-wrapper

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

File details

Details for the file brreg_wrapper-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: brreg_wrapper-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for brreg_wrapper-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5d25cda622e56b72c1a2e5e8f0e1741977d6a3b958ec38da968ebeaf41667121
MD5 92988133fe80f73fb964fbd6fce300e8
BLAKE2b-256 937ca3a6ebfc606f3be899842de2a82bc405c1c6c64d31cded57247658694814

See more details on using hashes here.

Provenance

The following attestation bundles were made for brreg_wrapper-0.1.4-py3-none-any.whl:

Publisher: publish-to-pypi.yml on sondreal/brreg-wrapper

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