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.3.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

url_matcher-0.3.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file url-matcher-0.3.0.tar.gz.

File metadata

  • Download URL: url-matcher-0.3.0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for url-matcher-0.3.0.tar.gz
Algorithm Hash digest
SHA256 cc51addbd574f5ad6ecaac4edc1a3ecf840ba75b63ebed1dcef38446f6ad6101
MD5 059a41aa693763b68bd29baeb3ded00e
BLAKE2b-256 c06e2e66d01ca255e7e6982006830a989ee44951bcb834e5e8fc38703415ba01

See more details on using hashes here.

File details

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

File metadata

  • Download URL: url_matcher-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for url_matcher-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 126cfbe6215c760eda2c20f1a8ce7a00274ea19ab184a39d05a4be9c2342cea4
MD5 6661a2faa50c062299313a2d033e080b
BLAKE2b-256 a73ecfbbcf52037bc86beafac8310daf6a597b1ce3b8d643db303fbea07b5bb6

See more details on using hashes here.

Supported by

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