Skip to main content

URL matching rules library to connect URLs with resources

Project description

PyPI Version Supported Python Versions Build Status Coverage report

URL matching library that relates URLs with resources. Rules are defined using simple pattern definitions. It is simpler and faster than using regular expressions if the rules involves many domains.

To illustrate it with an example, imagine that you have several proxy servers and you want to route requests to the right one. You could define the following rules:

  • site1.com →︎ us_proxy

  • site2.com/uk →︎ uk_proxy

  • site2.com/ie →︎ ie_proxy

All URLs from site1.com should use the US proxy. The situation for site2.com URLs are different: if the path starts with /uk, then use the UK proxy, otherwise use the IE proxy. This library allows to create a matcher that can be used to match URLs with the right proxy using these rules.

Have a look to https://github.com/zytedata/url-matcher/blob/main/url_matcher/example.py for an example of usage.

The following files are useful to understand the pattern, the set of patterns and how they behave:

The full documentation can be found at https://url-matcher.readthedocs.io/

License is BSD 3-clause.

Developing

Setup your local Python environment via:

  1. pip install -r requirements-dev.txt

  2. pre-commit install

Now everytime you perform a git commit, these tools will run against the staged files:

  • black

  • isort

  • flake8

  • mypy

You can also directly invoke pre-commit run --all-files to run them without performing a commit.

Using sphinx-autobuild

When working on documentation, it is convenient to use sphinx-autobuild. First, run pip install -r docs/requirements.txt sphinx-autobuild. Then run

sphinx-autobuild docs docs/_build/html

and then open http://127.0.0.1:8000/ in a browser, to see the current version of docs. A process would be running in a background, watching for docs changes; when docs are changed, a build is started, and the web page is refreshed automatically when the build is finished.

Project details


Download files

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

Source Distribution

url_matcher-0.6.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

url_matcher-0.6.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file url_matcher-0.6.0.tar.gz.

File metadata

  • Download URL: url_matcher-0.6.0.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for url_matcher-0.6.0.tar.gz
Algorithm Hash digest
SHA256 b5583392541e49fad0c64b287fca3af92de3eead7c004b35979b397d488f9e1b
MD5 d0c172c249bcfcab9c75c9dde9845699
BLAKE2b-256 4f9c98ae4ed808841dfe1d6585a173ef2ff07435a4626ab98ea7d020962a5ebc

See more details on using hashes here.

File details

Details for the file url_matcher-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: url_matcher-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for url_matcher-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 103342c3bb337b2fa641dba36156e0fa58fee8a78ab1ad947f117f495d57c2da
MD5 a408d39526c4f8fb33bbad6dbc3d4a35
BLAKE2b-256 dd46033e16331bdbcbfcddb279f147ddca5e3b08e2268a8786efad00b451bf03

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page