A simple router for HTTP applications

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for klen from gravatar.com klen

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Kirill Klenov
  • Tags http, http router, paths management
  • Requires: Python >=3.7
Classifiers

Project description

http-router – A simple router for HTTP applications

Tests Status PYPI Version Python Versions

Requirements

  • python >= 3.7

Installation

http-router should be installed using pip:

pip install http-router

Usage

Create a router:

from http_router import Router


# Initialize the router
router = Router(trim_last_slash=True)

Define routes:

@router.route('/simple')
def simple():
    return 'result from the fn'

Call the router with HTTP path and optionally method to get a match result.

match = router('/simple', method='GET')
assert match, 'HTTP path is ok'
assert match.target is simple

The router supports regex objects too:

import re

@router.route(re.compile(r'/regexp/\w{3}-\d{2}/?'))
def regex():
    return 'result from the fn'

But the lib has a simplier interface for the dynamic routes:

@router.route('/users/{username}')
def users():
    return 'result from the fn'

By default this will capture characters up to the end of the path or the next /.

Optionally, you can use a converter to specify the type of the argument like {variable_name:converter}.

Converter types:

str

(default) accepts any text without a slash

int

accepts positive integers

float

accepts positive floating point values

path

like string but also accepts slashes

uuid

accepts UUID strings

Convertors are used by prefixing them with a colon, like so:

@router.route('/orders/{order_id:int}')
def orders():
    return 'result from the fn'

Any unknown convertor will be parsed as a regex:

@router.route('/orders/{order_id:\d{3}}')
def orders():
    return 'result from the fn'

Multiple paths are supported as well:

@router.route('/', '/home')
def index():
    return 'index'

Handling HTTP methods:

@router.route('/only-post', methods=['POST'])
def only_post():
    return 'only-post'

Submounting routes:

subrouter = Router()

@subrouter('/items')
def items():
     pass

 router = Router()
 router.route('/api')(subrouter)


match = router('/api/items', method='GET')
assert match, 'HTTP path is ok'
assert match.target is items

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/http-router/issues

Contributing

Development of the project happens at: https://github.com/klen/http-router

License

Licensed under a MIT license.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for klen from gravatar.com klen

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Kirill Klenov
  • Tags http, http router, paths management
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

5.0.8

5.0.5

4.1.2

4.1.1

4.1.0

4.0.0

3.0.7

3.0.6

3.0.1

3.0.0

2.6.8

2.6.7

2.6.5

2.6.4

2.6.3

2.5.2

2.5.1

2.4.1

This version

2.3.2

2.3.0

2.2.1

2.2.0

2.1.0

2.0.22

2.0.20

2.0.19

2.0.17

2.0.16

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.1.4

1.1.3

1.1.2

1.1.1

0.8.1

0.8.0

0.7.1

0.7.0

0.6.0

0.5.1

0.5.0

0.4.1

0.4.0

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.0

0.1.0

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

Download files

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

Source Distribution

http-router-2.3.2.tar.gz (140.1 kB view details)

Uploaded Source

Built Distributions

http_router-2.3.2-cp39-cp39-win_amd64.whl (226.5 kB view details)

Uploaded CPython 3.9 Windows x86-64

http_router-2.3.2-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl (528.9 kB view details)

Uploaded CPython 3.9 manylinux: glibc 2.5+ x86-64

http_router-2.3.2-cp39-cp39-macosx_10_14_x86_64.whl (240.0 kB view details)

Uploaded CPython 3.9 macOS 10.14+ x86-64

http_router-2.3.2-cp38-cp38-win_amd64.whl (226.7 kB view details)

Uploaded CPython 3.8 Windows x86-64

http_router-2.3.2-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl (556.8 kB view details)

Uploaded CPython 3.8 manylinux: glibc 2.5+ x86-64

http_router-2.3.2-cp38-cp38-macosx_10_14_x86_64.whl (237.4 kB view details)

Uploaded CPython 3.8 macOS 10.14+ x86-64

http_router-2.3.2-cp37-cp37m-win_amd64.whl (224.4 kB view details)

Uploaded CPython 3.7m Windows x86-64

http_router-2.3.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (519.2 kB view details)

Uploaded CPython 3.7m manylinux: glibc 2.5+ x86-64

http_router-2.3.2-cp37-cp37m-macosx_10_14_x86_64.whl (236.1 kB view details)

Uploaded CPython 3.7m macOS 10.14+ x86-64

File details

Details for the file http-router-2.3.2.tar.gz.

File metadata

  • Download URL: http-router-2.3.2.tar.gz
  • Upload date:
  • Size: 140.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http-router-2.3.2.tar.gz
Algorithm Hash digest
SHA256 70981591e9b8653b4d2d1e7bc465903e85282c36841e28c4896a4d49bf3f0999
MD5 ed6614031074ab923108ca579d144404
BLAKE2b-256 e76e058f8b6f2521abb96bd9b23afabada0d8c409cbf7a48a0c06e7a4a5ab01f

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: http_router-2.3.2-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 226.5 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http_router-2.3.2-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 eab2bb5e18736c08c65608ef0be4c25e08affedc73d37aebed4bb9baa0a2fc46
MD5 37356d68b37fb56c8902c64185c55451
BLAKE2b-256 24d946d4f3debc09d2a2c9f4cc2766d999851e065bc8629b48968880e3432591

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for http_router-2.3.2-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a6cf1842ea253109d8d0b1feda33459bf9142a1732dc0472970cced66f5b3009
MD5 db00b84f3a6e16f7565e52ce2f79b3dc
BLAKE2b-256 3a4f478e2c31728a592e092a3c54b2463ead3fd4182e66767c29932d8e55e205

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp39-cp39-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: http_router-2.3.2-cp39-cp39-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 240.0 kB
  • Tags: CPython 3.9, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http_router-2.3.2-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 95ce98d4671188f043587b2f289730443be1d043ed326e1a97b9c7cffaf78012
MD5 6f7538dc6a8bde64246bb25d66782d08
BLAKE2b-256 01dac012c289a058a434b2dddc4f245905cf6d6a8153131fbd28f746a5da298a

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: http_router-2.3.2-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 226.7 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http_router-2.3.2-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 255397b8848b45e4e9151d469e851eb072f080703d4bc0e46d459c585f01a239
MD5 12b05bec9a2cf424ccf990f2bdb7ba9f
BLAKE2b-256 ecee19ef9fd29f0f86fbb805f73d370ae7e96ea90a541320e994dc82b0e7a1ba

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for http_router-2.3.2-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2be357aaf064881e4439eaa0fecfecc536e92df9a33afb71f8387c4f0ee15b23
MD5 90c9d4021dcd855e0764a19f50f7918d
BLAKE2b-256 b733e1acde881735384c147bb413ca156b14925c22c8a967366d63fe5b0408a0

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp38-cp38-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: http_router-2.3.2-cp38-cp38-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 237.4 kB
  • Tags: CPython 3.8, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http_router-2.3.2-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 4187821ce0db4ae11ce78172d3c2cc11f58ebd67c96e96afc4e1bda45054f0a5
MD5 9b6d9b20da376862c41d54b751eefaa2
BLAKE2b-256 44f31912eb18a90f37c6e5e4b17f0d4f0bb0b735cc663007085d715b55707125

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: http_router-2.3.2-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 224.4 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http_router-2.3.2-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 f33100edd3a05bd7efd96c3e503d9239f34e8c4d467af87872d41ff0028dfbcd
MD5 540aad42fd3f31e7dd8f90f4c86b9085
BLAKE2b-256 a3d97b7012e2b0872d9f2fa127394ef56a715fafd519e382752683f3050ee1ac

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for http_router-2.3.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f680c0ab568313deb6df25fddd872e8a95a6e10660147db4dda11fc121453294
MD5 07fa0b6b913fcf932a6d87e240320f33
BLAKE2b-256 ab1033f748ce50a65125153499f7acc7383a45b7991a22af1a2d11d42ad2d3e6

See more details on using hashes here.

File details

Details for the file http_router-2.3.2-cp37-cp37m-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: http_router-2.3.2-cp37-cp37m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 236.1 kB
  • Tags: CPython 3.7m, macOS 10.14+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for http_router-2.3.2-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 fb0e5c89e84453ac7d975e8fc3c51d00d8471838b8cbb550cc6ec3a14a99cb78
MD5 219d8cc8d59326d0e3133b96dd097b9e
BLAKE2b-256 ae6d773ce7311452eb52d8535095e840e46ab9fb19a00491163aeb3d2c49cc2d

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