Skip to main content

Django checks to ensure valid URL Configurations

Project description

PyPI Version Python Versions Django Versions Build Status codecov BCH compliance

Read Me

Use Django's System Check Framework to ensure your URL Configuration works correctly.

Table of Contents

Project Purpose

This package checks your Django project's URL Configuration for a few things.

  • Do the paths or regular expressions in your URL configuration tree end with slashes (or, for regular expressions, /$)
  • Is the URL configuration tree comprised of only URLPattern and URLResolver instances (path() and include())?
  • Is ROOT_URLCONF defined in settings, and does it point to a valid Python module with urlpatterns defined?

๐Ÿ” Up to Table of Contents

Project Rationale

I constantly forget to add a slash to the end of my URI paths. This leads to strange behavior, and can be tricky to catch even with proper testing.

What's more, the errors raised when something is amiss with the URL configuration can be tricky to debug and understand.

As such, this package aim to try and make developers lives easier by providing targeted checks of the URL configuration tree. This is meant to be used as part of a "belt-and-braces" approach, and is not a substitution for tests!

I am open to suggestions on improving the checks. Please open an issue to do so.

๐Ÿ” Up to Table of Contents

Installation and Usage

  1. Add "url_checks.apps.UrlChecksConfig", as an item in your Django project's INSTALLED_APPS setting
  2. In the terminal (in your Django projects code-root directory), run Django's check framework with $ python manage.py check
  3. Read the output in your terminal and track those bugs down!

๐ŸŽ‰

๐Ÿ” Up to Table of Contents

Contributing

For ideas, bugs, feature-requests, and all the rest, please open an issue on Github.

๐Ÿ” Up to Table of Contents

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_url_checks-0.2.0-py3-none-any.whl (11.2 kB) Copy SHA256 hash SHA256 Wheel py3
django-url-checks-0.2.0.tar.gz (5.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page