brreg-wrapper 0.1.0__py3-none-any.whl

brreg_wrapper/__init__.py

@@ -0,0 +1,4 @@
+# src/brreg_wrapper/__init__.py
+from .client import BrregClient
+
+__all__ = ["BrregClient"]

brreg_wrapper/client.py

@@ -0,0 +1,333 @@
+import httpx
+
+
+class BrregClient:
+    """
+    A client for interacting with the Brønnøysund Register Centre (Brreg) API.
+    API Documentation: https://data.brreg.no/enhetsregisteret/api/dokumentasjon/no/index.html
+    """
+
+    BASE_URL = "https://data.brreg.no/enhetsregisteret/api"
+
+    def __init__(self, timeout: float = 10.0, client: httpx.AsyncClient | None = None):
+        """
+        Initializes the BrregClient.
+
+        Args:
+            timeout: The timeout for HTTP requests in seconds. Defaults to 10.0.
+            client: An optional httpx.AsyncClient instance. If not provided,
+                    a new one is created.
+        """
+        self._client = client or httpx.AsyncClient(
+            base_url=self.BASE_URL, timeout=timeout
+        )
+
+    async def _request(
+        self,
+        method: str,
+        endpoint: str,
+        params: dict | None = None,
+        json: dict | None = None,
+    ) -> httpx.Response:
+        """
+        Makes an asynchronous HTTP request to the Brreg API.
+
+        Args:
+            method: The HTTP method (e.g., "GET", "POST").
+            endpoint: The API endpoint path (e.g., "/enheter").
+            params: Optional query parameters.
+            json: Optional JSON body for POST/PUT requests.
+
+        Returns:
+            The httpx.Response object.
+
+            Raises:
+            httpx.HTTPStatusError: If the API returns an error status code.
+        """
+        headers = {"Accept": "application/json"}
+        try:
+            response = await self._client.request(
+                method, endpoint, params=params, json=json, headers=headers
+            )
+            # Raise an exception for 4xx or 5xx status codes
+            response.raise_for_status()
+            return response
+        except httpx.RequestError as exc:
+            print(f"An error occurred while requesting {exc.request.url!r}: {exc}")
+            # Re-raise or handle specific errors as needed
+            raise
+        except httpx.HTTPStatusError as exc:
+            error_message = (
+                f"Error response {exc.response.status_code} "
+                f"while requesting {exc.request.url!r}: {exc.response.text}"
+            )
+            print(error_message)
+            # Re-raise or handle specific errors as needed
+            raise
+
+    async def close(self):
+        """Closes the underlying httpx client."""
+        await self._client.aclose()
+
+    # --- API Methods will be added below ---
+
+    async def get_enhet(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves information about a specific entity (enhet) by its
+        organization number.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-enheter-detalj
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number.
+
+        Returns:
+            A dictionary containing the entity's information.
+        """
+        endpoint = f"/enheter/{organisasjonsnummer}"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def search_enheter(self, **kwargs) -> dict:
+        """
+        Searches for entities (enheter) based on various criteria.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-enheter-oppslag
+
+        Args:
+            **kwargs: Search parameters as defined in the API documentation.
+                      Examples: navn, organisasjonsform, postadresse.postnummer, etc.
+
+        Returns:
+            A dictionary containing the search results.
+        """
+        endpoint = "/enheter"
+        # Filter out None values from kwargs
+        params = {k: v for k, v in kwargs.items() if v is not None}
+        response = await self._request("GET", endpoint, params=params)
+        return response.json()
+
+    async def get_underenhet(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves information about a specific sub-entity (underenhet) by its
+        organization number.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-underenheter-detalj
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the sub-entity.
+
+        Returns:
+            A dictionary containing the sub-entity's information.
+        """
+        endpoint = f"/underenheter/{organisasjonsnummer}"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def search_underenheter(self, **kwargs) -> dict:
+        """
+        Searches for sub-entities (underenheter) based on various criteria.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-underenheter-oppslag
+
+        Args:
+            **kwargs: Search parameters as defined in the API documentation.
+
+        Returns:
+            A dictionary containing the search results.
+        """
+        endpoint = "/underenheter"
+        # Filter out None values from kwargs
+        params = {k: v for k, v in kwargs.items() if v is not None}
+        response = await self._request("GET", endpoint, params=params)
+        return response.json()
+
+    # --- Roles Endpoints ---
+
+    async def get_rollegrupper(self) -> dict:
+        """
+        Retrieves all role groups.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-roller-rollegrupper
+
+        Returns:
+            A dictionary containing the list of role groups.
+        """
+        endpoint = "/roller/rollegrupper"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_roller(self) -> dict:
+        """
+        Retrieves all roles.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-roller-roller
+
+        Returns:
+            A dictionary containing the list of roles.
+        """
+        endpoint = "/roller/roller"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_enhet_roller(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves roles associated with a specific entity (enhet).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-roller-roller-for-enhet
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the entity.
+
+        Returns:
+            A dictionary containing the roles for the entity.
+        """
+        endpoint = f"/enheter/{organisasjonsnummer}/roller"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_underenhet_roller(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves roles associated with a specific sub-entity (underenhet).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-roller-roller-for-underenhet
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the sub-entity.
+
+        Returns:
+            A dictionary containing the roles for the sub-entity.
+        """
+        endpoint = f"/underenheter/{organisasjonsnummer}/roller"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    # --- Grunndata Endpoints ---
+
+    async def get_grunndata_enhet(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves basic data (grunndata) for a specific entity (enhet).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-grunndata-enhet
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the entity.
+
+        Returns:
+            A dictionary containing the basic data for the entity.
+        """
+        endpoint = f"/grunndata/enheter/{organisasjonsnummer}"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_grunndata_underenhet(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves basic data (grunndata) for a specific sub-entity (underenhet).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-grunndata-underenhet
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the sub-entity.
+
+        Returns:
+            A dictionary containing the basic data for the sub-entity.
+        """
+        endpoint = f"/grunndata/underenheter/{organisasjonsnummer}"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    # --- Code List Endpoints ---
+
+    async def get_organisasjonsformer(self) -> dict:
+        """
+        Retrieves all organization forms.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-kodeverk-organisasjonsformer
+
+        Returns:
+            A dictionary containing the list of organization forms.
+        """
+        endpoint = "/organisasjonsformer"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_naeringskoder(self) -> dict:
+        """
+        Retrieves all industry codes (Næringskoder - NACE).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-kodeverk-naeringskoder
+
+        Returns:
+            A dictionary containing the list of industry codes.
+        """
+        endpoint = "/naeringskoder"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_sektorkoder(self) -> dict:
+        """
+        Retrieves all sector codes.
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-kodeverk-sektorkoder
+
+        Returns:
+            A dictionary containing the list of sector codes.
+        """
+        endpoint = "/sektorkoder"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    # --- Update Endpoints ---
+
+    async def get_enhet_oppdateringer(self, **kwargs) -> dict:
+        """
+        Retrieves updates for entities (enheter).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-oppdateringer-enheter
+
+        Args:
+            **kwargs: Optional query parameters like oppdateringsid, dato,
+                      fraAntallDoegn, status, oppdateringstype, page, size.
+
+        Returns:
+            A dictionary containing the entity updates.
+        """
+        endpoint = "/oppdateringer/enheter"
+        params = {k: v for k, v in kwargs.items() if v is not None}
+        response = await self._request("GET", endpoint, params=params)
+        return response.json()
+
+    async def get_underenhet_oppdateringer(self, **kwargs) -> dict:
+        """
+        Retrieves updates for sub-entities (underenheter).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-oppdateringer-underenheter
+
+        Args:
+            **kwargs: Optional query parameters like oppdateringsid, dato,
+                      fraAntallDoegn, status, oppdateringstype, page, size.
+
+        Returns:
+            A dictionary containing the sub-entity updates.
+        """
+        endpoint = "/oppdateringer/underenheter"
+        params = {k: v for k, v in kwargs.items() if v is not None}
+        response = await self._request("GET", endpoint, params=params)
+        return response.json()
+
+    # --- History Endpoints ---
+
+    async def get_enhet_historikk(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves historical data for a specific entity (enhet).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-historikk-enhet
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the entity.
+
+        Returns:
+            A dictionary containing the historical data for the entity.
+        """
+        endpoint = f"/enheter/{organisasjonsnummer}/historikk"
+        response = await self._request("GET", endpoint)
+        return response.json()
+
+    async def get_underenhet_historikk(self, organisasjonsnummer: str) -> dict:
+        """
+        Retrieves historical data for a specific sub-entity (underenhet).
+        Ref: https://data.brreg.no/enhetsregisteret/api/docs/index.html#rest-api-historikk-underenhet
+
+        Args:
+            organisasjonsnummer: The 9-digit organization number of the sub-entity.
+
+        Returns:
+            A dictionary containing the historical data for the sub-entity.
+        """
+        endpoint = f"/underenheter/{organisasjonsnummer}/historikk"
+        response = await self._request("GET", endpoint)
+        return response.json()

brreg_wrapper-0.1.0.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: brreg-wrapper
+Version: 0.1.0
+Summary: A Python wrapper for the Brønnøysund Register Centre (Brreg) API.
+Author-email: Sondre Dyrnes <sondre@villdyr.no>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sondreal/brreg-wrapper
+Project-URL: Repository, https://github.com/sondreal/brreg-wrapper
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Office/Business
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1.0,>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest<9.0,>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio<1.0,>=0.23; extra == "dev"
+Requires-Dist: pytest-httpx<1.0,>=0.29; extra == "dev"
+Requires-Dist: ruff<1.0,>=0.3; extra == "dev"
+Dynamic: license-file
+
+# 🔥 Brreg Wrapper
+
+[![PyPI version](https://img.shields.io/pypi/v/brreg-wrapper.svg)](https://pypi.org/project/brreg-wrapper/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python Version](https://img.shields.io/pypi/pyversions/brreg-wrapper.svg)](https://pypi.org/project/brreg-wrapper/)
+
+<!-- Optional: Add build status badge if you set up CI beyond publishing -->
+<!-- [![Build Status](https://github.com/sondreal/brreg-wrapper/actions/workflows/your-ci-workflow.yml/badge.svg)](https://github.com/sondreal/brreg-wrapper/actions/workflows/your-ci-workflow.yml) -->
+
+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.
+
+## ✨ Features
+
+- **Asynchronous:** Built with `asyncio` and `httpx` for modern, non-blocking I/O.
+- **Simple Interface:** Clean methods like `get_enhet`, `get_underenhet`, `search_enheter`, `search_underenheter`.
+- **Type Hinted:** Fully type-hinted for better developer experience and static analysis.
+- **Minimal Dependencies:** Relies only on the excellent `httpx` library.
+- **PyPI Ready:** Easy to install and integrate.
+
+## 🚀 Installation
+
+Get started in seconds:
+
+```bash
+pip install brreg-wrapper
+# Or using uv:
+# uv pip install brreg-wrapper
+```
+
+## 💡 Usage Example
+
+Here's a taste of how easy it is to fetch data:
+
+```python
+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 = "982038576" # Example: Google Norway AS
+
+        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](https://github.com/sondreal/brreg-wrapper).
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. Remember to replace `[year]` and `[fullname]` in the file!
+
+## ⚠️ Issues?
+
+Having trouble? Found a bug? Feel free to open an issue on the [GitHub repository](https://github.com/sondreal/brreg-wrapper/issues).

brreg_wrapper-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+brreg_wrapper/__init__.py,sha256=J8HOyoxvoUAq4a6CtrcVr5O5m9q6cfUaViuHQDWVZuY,91
+brreg_wrapper/client.py,sha256=Ir5W4GLz3I5B8iWPYqdtFGpMfrbFLLnZuiA2DxwgADw,12445
+brreg_wrapper-0.1.0.dist-info/licenses/LICENSE,sha256=ACwmltkrXIz5VsEQcrqljq-fat6ZXAMepjXGoe40KtE,1069
+brreg_wrapper-0.1.0.dist-info/METADATA,sha256=Rww9A-nQ5HQIWy3mrSOri-trcrpd8_5qqpN6LP1_Dp8,4228
+brreg_wrapper-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+brreg_wrapper-0.1.0.dist-info/top_level.txt,sha256=DCKBna9al_TqtzSfYTV7Mrl9f6NTRYMC3aavlSqicMY,14
+brreg_wrapper-0.1.0.dist-info/RECORD,,

brreg_wrapper-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

brreg_wrapper-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

brreg_wrapper-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+brreg_wrapper