# 📇 python-brreg
_API client for Brønnøysundregistrene's open API._
[![Tests](https://img.shields.io/github/actions/workflow/status/crdbrd/python-brreg/tests.yml?branch=main)](https://github.com/crdbrd/python-brreg/actions/workflows/tests.yml)
[![Docs](https://img.shields.io/readthedocs/brreg)](https://brreg.readthedocs.io/en/latest/)
[![Coverage](https://img.shields.io/codecov/c/gh/crdbrd/python-brreg)](https://codecov.io/gh/crdbrd/python-brreg)
[![PyPI](https://img.shields.io/pypi/v/brreg)](https://pypi.org/project/brreg/)
---
`python-brreg`is a Python library for interacting with the open APIs of the
Norwegian Business Registry, [Brønnøysundregistrene](https://www.brreg.no/).
## Installation
The library requires Python 3.8 or newer.
The library can be installed from [PyPI](https://pypi.org/project/brreg/):
```
python3 -m pip install brreg
```
## Project resources
- [Documentation](https://brreg.readthedocs.io/)
- [Source code](https://github.com/crdbrd/python-brreg)
- [Releases](https://github.com/crdbrd/python-brreg/releases)
- [Issue tracker](https://github.com/crdbrd/python-brreg/issues)
- [Contributors](https://github.com/crdbrd/python-brreg/graphs/contributors)
## Features
### Enhetsregistret
The `brreg.enhetsregisteret` part of this library wraps the open
[Enhetsregistret API](https://data.brreg.no/enhetsregisteret/api/docs/index.html).
This is a list of all features this library could implement on top of this API.
However, I will not attempt to make the project cover all parts of
Brønnøysundregisterene's API. I am open to requests, so that time is spent on
the parts of the API that there is an actual demand for.
- Enheter
- Search - Implemented
- Get one by organization number - Implemented
- Get one's roles by organization number - Implemented
- Get all updates since given time - Request if needed
- Underenheter
- Search - Implemented
- Get one by organization number - Implemented
- Get all updates since given time - Request if needed
- Organisasjonsform
- Get all - Request if needed
- Rolletype
- Get all - Request if needed
- Get one - Request if needed
- Rollegruppetype
- Get all - Request if needed
- Get one - Request if needed
- Representant
- Get all - Request if needed
- Get one - Request if needed
- Kommuner
- Get all - Request if needed
- Matrikkelenhet
- Get one by matrikkelnummer - Request if needed
- Get one by matrikkelenhet-ID - Request if needed
## License
Copyright
2019 [Otovo ASA](https://www.otovo.com/),
2023-2024 [Cardboard AS](https://cardboard.inc/).
Licensed under the
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Raw data
{
"_id": null,
"home_page": "https://github.com/crdbrd/python-brreg",
"name": "brreg",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.0",
"maintainer_email": null,
"keywords": "brreg, enhetsregisteret",
"author": "Stein Magnus Jodal",
"author_email": "stein.magnus@jodal.no",
"download_url": "https://files.pythonhosted.org/packages/47/ea/3832a242dd3585ffb782cef50e6f36595f17adb175adb20f4266e2a53f2c/brreg-1.1.0.tar.gz",
"platform": null,
"description": "# 📇 python-brreg\n\n_API client for Br\u00f8nn\u00f8ysundregistrene's open API._\n\n[![Tests](https://img.shields.io/github/actions/workflow/status/crdbrd/python-brreg/tests.yml?branch=main)](https://github.com/crdbrd/python-brreg/actions/workflows/tests.yml)\n[![Docs](https://img.shields.io/readthedocs/brreg)](https://brreg.readthedocs.io/en/latest/)\n[![Coverage](https://img.shields.io/codecov/c/gh/crdbrd/python-brreg)](https://codecov.io/gh/crdbrd/python-brreg)\n[![PyPI](https://img.shields.io/pypi/v/brreg)](https://pypi.org/project/brreg/)\n\n---\n\n`python-brreg`is a Python library for interacting with the open APIs of the\nNorwegian Business Registry, [Br\u00f8nn\u00f8ysundregistrene](https://www.brreg.no/).\n\n## Installation\n\nThe library requires Python 3.8 or newer.\n\nThe library can be installed from [PyPI](https://pypi.org/project/brreg/):\n\n```\npython3 -m pip install brreg\n```\n\n## Project resources\n\n- [Documentation](https://brreg.readthedocs.io/)\n- [Source code](https://github.com/crdbrd/python-brreg)\n- [Releases](https://github.com/crdbrd/python-brreg/releases)\n- [Issue tracker](https://github.com/crdbrd/python-brreg/issues)\n- [Contributors](https://github.com/crdbrd/python-brreg/graphs/contributors)\n\n## Features\n\n### Enhetsregistret\n\nThe `brreg.enhetsregisteret` part of this library wraps the open\n[Enhetsregistret API](https://data.brreg.no/enhetsregisteret/api/docs/index.html).\n\nThis is a list of all features this library could implement on top of this API.\nHowever, I will not attempt to make the project cover all parts of\nBr\u00f8nn\u00f8ysundregisterene's API. I am open to requests, so that time is spent on\nthe parts of the API that there is an actual demand for.\n\n- Enheter\n - Search - Implemented\n - Get one by organization number - Implemented\n - Get one's roles by organization number - Implemented\n - Get all updates since given time - Request if needed\n- Underenheter\n - Search - Implemented\n - Get one by organization number - Implemented\n - Get all updates since given time - Request if needed\n- Organisasjonsform\n - Get all - Request if needed\n- Rolletype\n - Get all - Request if needed\n - Get one - Request if needed\n- Rollegruppetype\n - Get all - Request if needed\n - Get one - Request if needed\n- Representant\n - Get all - Request if needed\n - Get one - Request if needed\n- Kommuner\n - Get all - Request if needed\n- Matrikkelenhet\n - Get one by matrikkelnummer - Request if needed\n - Get one by matrikkelenhet-ID - Request if needed\n\n## License\n\nCopyright\n2019 [Otovo ASA](https://www.otovo.com/),\n2023-2024 [Cardboard AS](https://cardboard.inc/).\n\nLicensed under the\n[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "API client for Br\u00f8nn\u00f8ysundregistrene.",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://brreg.readthedocs.io",
"Homepage": "https://github.com/crdbrd/python-brreg",
"Repository": "https://github.com/crdbrd/python-brreg"
},
"split_keywords": [
"brreg",
" enhetsregisteret"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8985f323a3bf61583246e2187fa9dc5375085e499eb4b7b3490344862467d9e",
"md5": "f6885e68a9ab72412052f41745493892",
"sha256": "ebdf3e2fd1c798ae93697bf3162c7dbbdb372741bcd97e765d42c425d5c2e537"
},
"downloads": -1,
"filename": "brreg-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6885e68a9ab72412052f41745493892",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.0",
"size": 15378,
"upload_time": "2024-08-18T09:34:32",
"upload_time_iso_8601": "2024-08-18T09:34:32.602135Z",
"url": "https://files.pythonhosted.org/packages/b8/98/5f323a3bf61583246e2187fa9dc5375085e499eb4b7b3490344862467d9e/brreg-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47ea3832a242dd3585ffb782cef50e6f36595f17adb175adb20f4266e2a53f2c",
"md5": "c77c010a1886db4ed7fd5001ac3741e4",
"sha256": "43af4068c1f58ba80c84ae8fa1dbd6064a3789852a67a14d6adc6fd34e29f51f"
},
"downloads": -1,
"filename": "brreg-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c77c010a1886db4ed7fd5001ac3741e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.0",
"size": 14163,
"upload_time": "2024-08-18T09:34:33",
"upload_time_iso_8601": "2024-08-18T09:34:33.823602Z",
"url": "https://files.pythonhosted.org/packages/47/ea/3832a242dd3585ffb782cef50e6f36595f17adb175adb20f4266e2a53f2c/brreg-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 09:34:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crdbrd",
"github_project": "python-brreg",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "brreg"
}