Replaced html2text with beautifulsoup4 to make package available under MIT license (#33)

Author: GitRon

.ambient-package-update/metadata.py

@@ -1,7 +1,7 @@
 from ambient_package_update.metadata.author import PackageAuthor
 from ambient_package_update.metadata.constants import (
     DEV_DEPENDENCIES,
-    LICENSE_GPL,
+    LICENSE_MIT,
     SUPPORTED_DJANGO_VERSIONS,
     SUPPORTED_PYTHON_VERSIONS,
 )
@@ -21,14 +21,14 @@
     ],
     maintainer=PackageMaintainer(name="Ambient Digital", url="https://ambient.digital/", email="[email protected]"),
     licenser="Ambient Innovation: GmbH",
-    license=LICENSE_GPL,
+    license=LICENSE_MIT,
     license_year=2023,
     development_status="5 - Production/Stable",
     has_migrations=False,
     readme_content=ReadmeContent(uses_internationalisation=True),
     dependencies=[
         f"Django>={SUPPORTED_DJANGO_VERSIONS[0]}",
-        "html2text>=2020.1.16",
+        "beautifulsoup4>=4.13",
     ],
     supported_django_versions=SUPPORTED_DJANGO_VERSIONS,
     supported_python_versions=SUPPORTED_PYTHON_VERSIONS,

CHANGES.md

@@ -1,5 +1,11 @@
 # Changelog
 
+**2.7.0** (2025-05-21)
+  * Replaced `html2text` with `beautifulsoup4` to make package available under MIT license
+  * Switched back to MIT license
+  * Added `CONTRIBUTING.md` file and removed contributing guidelines from readme
+  * Maintenance updates via ambient-package-update
+
 **2.6.3** (2025-05-09)
   * Replaced docstring type hints with proper Pythonic ones in test suit
 

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contribute
+
+## Setup package for development
+
+- Create a Python virtualenv and activate it
+- Install "pip-tools" with `pip install -U pip-tools`
+- Compile the requirements with `pip-compile --extra dev, -o requirements.txt pyproject.toml --resolver=backtracking`
+- Sync the dependencies with your virtualenv with `pip-sync`
+
+## Add functionality
+
+- Create a new branch for your feature
+- Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
+  `-e /Users/workspace/django-pony-express` or via pip  `pip install -e /Users/workspace/django-pony-express`
+- Ensure the code passes the tests
+- Create a pull request
+
+## Run tests
+
+- Run tests
+  ````
+  pytest --ds settings tests
+  ````
+
+- Check coverage
+  ````
+  coverage run -m pytest --ds settings tests
+  coverage report -m
+  ````
+
+## Git hooks (via pre-commit)
+
+We use pre-push hooks to ensure that only linted code reaches our remote repository and pipelines aren't triggered in
+vain.
+
+To enable the configured pre-push hooks, you need to [install](https://pre-commit.com/) pre-commit and run once:
+
+    pre-commit install -t pre-push -t pre-commit --install-hooks
+
+This will permanently install the git hooks for both, frontend and backend, in your local
+[`.git/hooks`](./.git/hooks) folder.
+The hooks are configured in the [`.pre-commit-config.yaml`](templates/.pre-commit-config.yaml.tpl).
+
+You can check whether hooks work as intended using the [run](https://pre-commit.com/#pre-commit-run) command:
+
+    pre-commit run [hook-id] [options]
+
+Example: run single hook
+
+    pre-commit run ruff --all-files
+
+Example: run all hooks of pre-push stage
+
+    pre-commit run --all-files --hook-stage push
+
+## Update documentation
+
+- To build the documentation, run: `sphinx-build docs/ docs/_build/html/`.
+- Open `docs/_build/html/index.html` to see the documentation.
+
+
+### Translation files
+
+If you have added custom text, make sure to wrap it in `_()` where `_` is
+gettext_lazy (`from django.utils.translation import gettext_lazy as _`).
+
+How to create translation file:
+
+* Navigate to `django-pony-express`
+* `python manage.py makemessages -l de`
+* Have a look at the new/changed files within `django_pony_express/locale`
+
+How to compile translation files:
+
+* Navigate to `django-pony-express`
+* `python manage.py compilemessages`
+* Have a look at the new/changed files within `django_pony_express/locale`
+