boa-restrictor 1.0.0__tar.gz

boa_restrictor-1.0.0/.ambient-package-update/metadata.py

@@ -0,0 +1,45 @@
+from ambient_package_update.metadata.author import PackageAuthor
+from ambient_package_update.metadata.constants import (
+    DEV_DEPENDENCIES,
+    LICENSE_MIT,
+    SUPPORTED_DJANGO_VERSIONS,
+    SUPPORTED_PYTHON_VERSIONS,
+)
+from ambient_package_update.metadata.executables import ScriptExecutable
+from ambient_package_update.metadata.maintainer import PackageMaintainer
+from ambient_package_update.metadata.package import PackageMetadata
+from ambient_package_update.metadata.readme import ReadmeContent
+from ambient_package_update.metadata.ruff_ignored_inspection import RuffIgnoredInspection
+
+METADATA = PackageMetadata(
+    package_name="boa-restrictor",
+    github_package_group="ambient-innovation",
+    authors=[
+        PackageAuthor(
+            name="Ambient Digital",
+            email="hello@ambient.digital",
+        ),
+    ],
+    maintainer=PackageMaintainer(name="Ambient Digital", url="https://ambient.digital/", email="hello@ambient.digital"),
+    company="Ambient Innovation: GmbH",
+    license=LICENSE_MIT,
+    license_year=2024,
+    development_status="4 - Beta",
+    has_migrations=False,
+    readme_content=ReadmeContent(uses_internationalisation=False),
+    main_branch="main",
+    is_django_package=False,
+    dependencies=['tomli; python_version < "3.11"'],
+    supported_django_versions=SUPPORTED_DJANGO_VERSIONS,
+    supported_python_versions=SUPPORTED_PYTHON_VERSIONS,
+    optional_dependencies={
+        "dev": [
+            *DEV_DEPENDENCIES,
+        ],
+    },
+    ruff_ignore_list=[
+        RuffIgnoredInspection(key="TD002", comment="Missing issue link on the line following this TODO"),
+        RuffIgnoredInspection(key="TD003", comment="Missing issue link on the line following this TODO"),
+    ],
+    script_executables=[ScriptExecutable(name="boa-restrictor", import_path="boa_restrictor.cli.main:main")],
+)

boa_restrictor-1.0.0/.ambient-package-update/templates/snippets/content.tpl

@@ -0,0 +1,42 @@
+## Rules
+
+### Positional arguments not allowed (PBR001)
+
+This rule enforces that functions and methods don't contain any positional arguments.
+
+This will make refactorings easier, is more explicit,
+and you avoid the [boolean bug trap](https://adamj.eu/tech/2021/07/10/python-type-hints-how-to-avoid-the-boolean-trap/).
+
+*Wrong:*
+
+```python
+def my_func(a, b):
+    pass
+```
+
+*Correct:*
+
+```python
+def my_func(*, a, b):
+    pass
+```
+
+### Return type hints required if a return statement exists (PBR002)
+
+This rule will enforce that you add a return type-hint to all methods and functions that contain a `return` statement.
+This way we can be more explicit and let the IDE help the next developer because it will add warnings if you use
+wrong types.
+
+*Wrong:*
+
+```python
+def my_func(a, b):
+    return a * b
+```
+
+*Correct:*
+
+```python
+def my_func(a, b) -> int:
+    return a * b
+```

boa_restrictor-1.0.0/.ambient-package-update/templates/snippets/installation.tpl

@@ -0,0 +1,61 @@
+## Installation
+
+Add the following to your .pre-commit-config.yaml file:
+
+```yml
+  - repo: https://github.com/ambient-innovation/boa-restrictor
+    rev: v{{ version }}
+    hooks:
+      - id: boa-restrictor
+        args: [ --config=pyproject.toml ]
+```
+
+Now you can run the linter manually:
+
+    pre-commit run --all-files boa-restrictor
+
+
+## Configuration
+
+### Exclude certain files
+
+You can easily exclude certain files, for example, your tests, by using the `exclude` parameter from `pre-commit`:
+
+```yml
+  - repo: https://github.com/ambient-innovation/boa-restrictor
+    rev: v{{ version }}
+    hooks:
+      - id: boa-restrictor
+        ...
+        exclude: |
+          (?x)^(
+            /.*/tests/.*
+            |.*/test_.*\.py
+          )$
+```
+
+### Exclude configuration rule
+
+You can disable any rule in your `pyproject.toml` file as follows:
+
+```toml
+[tool.boa-restrictor]
+exclude = [
+    "PBR001",
+    "PBR002",
+]
+```
+
+### Ruff support
+
+If you are using `ruff`, you need to tell it about our linting rules. Otherwise, ruff will remove all `# noqa`
+statements from your codebase.
+
+```toml
+[tool.ruff.lint]
+# Avoiding flagging (and removing) any codes starting with `PBR` from any
+# `# noqa` directives, despite Ruff's lack of support for `boa-restrictor`.
+external = ["PBR"]
+```
+
+https://docs.astral.sh/ruff/settings/#lint_extend-unsafe-fixes

boa_restrictor-1.0.0/.ambient-package-update/templates/snippets/tagline.tpl

@@ -0,0 +1 @@
+Welcome to the **boa-restrictor** - a custom Python linter from Ambient

boa_restrictor-1.0.0/.editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+ij_continuation_indent_size = 8
+
+[*.yml]
+indent_style = space
+indent_size = 2

boa_restrictor-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: Unit tests
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  linting:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install required packages
+        run: pip install pre-commit
+
+      - name: Run pre-commit hooks
+        run: pre-commit run --all-files --hook-stage push
+
+
+  tests:
+    name: Python ${{ matrix.python-version }}, django ${{ matrix.django-version }}
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', ]
+        django-version: ['42', '50', '51', ]
+
+        exclude:
+          - python-version: '3.9'
+            django-version: 50
+          - python-version: '3.9'
+            django-version: 51
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install tox
+        run: pip install tox
+      - name: Run Tests
+        env:
+          TOXENV: django${{ matrix.django-version }}
+        run: tox
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-data-${{ matrix.python-version }}-${{ matrix.django-version }}
+          path: '${{ github.workspace }}/.coverage.*'
+          include-hidden-files: true
+          if-no-files-found: error
+
+  coverage:
+    name: Coverage
+    runs-on: ubuntu-24.04
+    needs: tests
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade coverage[toml]
+
+      - name: Download data
+        uses: actions/download-artifact@v4
+        with:
+          path: ${{ github.workspace }}
+          pattern: coverage-data-*
+          merge-multiple: true
+
+      - name: Combine coverage and fail if it's <100.0%
+        run: |
+          python -m coverage combine
+          python -m coverage html --skip-covered --skip-empty
+          python -m coverage report --fail-under=100.0
+          echo "## Coverage summary" >> $GITHUB_STEP_SUMMARY
+          python -m coverage report --format=markdown >> $GITHUB_STEP_SUMMARY

boa_restrictor-1.0.0/.gitignore

@@ -0,0 +1,158 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file. For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Requirements.txt is managed by pip-tools
+requirements.txt
+
+# sphinx build folder
+_build
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+
+# Test databases
+*.sqlite

boa_restrictor-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+# you find the full pre-commit-tools docu under:
+# https://pre-commit.com/
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.7.4
+    hooks:
+      # Run the Ruff linter.
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      # Run the Ruff formatter.
+      - id: ruff-format
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.19.1
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+        - black==24.10.0
+        files: '(?:README\.md|docs\/.*\.(?:md|rst))'
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.0
+    hooks:
+      - id: pyupgrade
+        args: [ --py39-plus ]
+        stages: [ pre-push ]
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.22.1
+    hooks:
+      - id: django-upgrade
+        args: [--target-version, "4.2"]
+        stages: [ pre-push ]
+
+  - repo: https://github.com/adamchainz/djade-pre-commit
+    rev: 1.3.2
+    hooks:
+    -   id: djade
+        args: [--target-version, "4.2"]
+        exclude: |
+          (?x)^(
+            charts/.*
+            |.*\.py
+          )$
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: no-commit-to-branch
+        args:
+          [
+            "--pattern",
+            '^^(?!(?:feature|hotfix|bugfix|refactor|maintenance)/[\w\d\-_#]+).*$',
+          ]
+        stages: [ pre-commit ]

boa_restrictor-1.0.0/.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+- id: boa-restrictor
+  name: Boa Restrictor Linter by Ambient
+  description: A custom Python linter by Ambient
+  entry: boa-restrictor
+  language: python
+  types: [ python ]

boa_restrictor-1.0.0/.readthedocs.yaml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev

boa_restrictor-1.0.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ambient Innovation: GmbH
+
+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.

boa_restrictor-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE.md
+recursive-exclude * *.pyc
+recursive-include boa-restrictor *.py *.html *.js *.cfg *.mo *.po