Modernize project

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: jodal

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: daily
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily

.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    environment: release
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - run: pip install nox==2023.4.22 poetry==1.7.0
+      - run: nox --python 3.12
+      - run: poetry build
+      - run: poetry publish --username=__token__ --password=${{ secrets.PYPI_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install nox==2023.4.22 poetry==1.7.0
+      - run: nox --python ${{ matrix.python-version }}
+      - uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,9 +1,12 @@
-/*.egg-info/
-/.coverage*
-/.mypy_cache/
-/.pytest_cache/
+*.egg-info/
+/.*_cache/
+/.coverage
+/.dmypy.json
+/.nox/
 /.tox/
-/build/
+/.venv/
+/coverage.xml
 /dist/
 /docs/_build/
-__pycache__
+/poetry.lock
+__pycache__/

.readthedocs.yml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+  jobs:
+    post_install:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+      - poetry install --all-extras --only=main,docs
+
+sphinx:
+  configuration: docs/conf.py
+  builder: dirhtml
+
+formats: all

.tool-versions

@@ -0,0 +1,3 @@
+node   21.1.0
+poetry 1.7.0
+python 3.12 3.11 3.10 3.9 3.8

README.md

@@ -0,0 +1,54 @@
+# 📇 python-brreg
+
+_API client for Brønnøysundregistrene's open API._
+
+[![Tests](https://img.shields.io/github/actions/workflow/status/jodal/python-brreg/tests.yml?branch=main)](https://github.com/jodal/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/jodal/python-brreg)](https://codecov.io/gh/jodal/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 package is available from [PyPI](https://pypi.org/project/brreg/):
+
+```
+python3 -m pip install brreg
+```
+
+## Project resources
+
+- [Documentation](https://brreg.readthedocs.io/)
+- [Source code](https://github.com/jodal/python-brreg)
+- [Releases](https://github.com/jodal/python-brreg/releases)
+- [Issue tracker](https://github.com/jodal/python-brreg/issues)
+- [Contributors](https://github.com/jodal/python-brreg/graphs/contributors)
+
+## Development status
+
+This project was originally developed in 2019 while I worked at Otovo.
+Eventually, it was never used there, and at the end of 2023, I got the project
+back under my control.
+
+I intend to brush the project up with modern project tooling and typing hints,
+making it a good foundation to build upon, and will release a 1.0 release as
+soon as that is done.
+
+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.
+
+## License
+
+`python-brreg` is copyright
+2019 [Otovo ASA](https://www.otovo.com/),
+2023 Stein Magnus Jodal and contributors.
+
+`python-brreg` is licensed under the
+[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).