| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- Metadata-Version: 2.1
- Name: uritemplate
- Version: 4.1.1
- Summary: Implementation of RFC 6570 URI Templates
- Home-page: https://uritemplate.readthedocs.org
- Author: Ian Stapleton Cordasco
- Author-email: graffatcolmingov@gmail.com
- License: BSD 3-Clause License or Apache License, Version 2.0
- Keywords: rfc 6570 uri template
- Platform: UNKNOWN
- Classifier: Development Status :: 5 - Production/Stable
- Classifier: Intended Audience :: Developers
- Classifier: License :: OSI Approved
- Classifier: License :: OSI Approved :: Apache Software License
- Classifier: License :: OSI Approved :: BSD License
- Classifier: Programming Language :: Python
- Classifier: Programming Language :: Python :: 3
- Classifier: Programming Language :: Python :: 3.6
- Classifier: Programming Language :: Python :: 3.7
- Classifier: Programming Language :: Python :: 3.8
- Classifier: Programming Language :: Python :: 3.9
- Classifier: Programming Language :: Python :: 3.10
- Classifier: Programming Language :: Python :: Implementation :: CPython
- Requires-Python: >=3.6
- Description-Content-Type: text/x-rst
- License-File: LICENSE
- uritemplate
- ===========
- Documentation_ -- GitHub_ -- Travis-CI_
- Simple python library to deal with `URI Templates`_. The API looks like
- .. code-block:: python
- from uritemplate import URITemplate, expand
- # NOTE: URI params must be strings not integers
- gist_uri = 'https://api.github.com/users/sigmavirus24/gists{/gist_id}'
- t = URITemplate(gist_uri)
- print(t.expand(gist_id='123456'))
- # => https://api.github.com/users/sigmavirus24/gists/123456
- # or
- print(expand(gist_uri, gist_id='123456'))
- # also
- t.expand({'gist_id': '123456'})
- print(expand(gist_uri, {'gist_id': '123456'}))
- Where it might be useful to have a class
- .. code-block:: python
- import requests
- class GitHubUser(object):
- url = URITemplate('https://api.github.com/user{/login}')
- def __init__(self, name):
- self.api_url = url.expand(login=name)
- response = requests.get(self.api_url)
- if response.status_code == 200:
- self.__dict__.update(response.json())
- When the module containing this class is loaded, ``GitHubUser.url`` is
- evaluated and so the template is created once. It's often hard to notice in
- Python, but object creation can consume a great deal of time and so can the
- ``re`` module which uritemplate relies on. Constructing the object once should
- reduce the amount of time your code takes to run.
- Installing
- ----------
- ::
- pip install uritemplate
- License
- -------
- Modified BSD license_
- .. _Documentation: https://uritemplate.readthedocs.io/
- .. _GitHub: https://github.com/python-hyper/uritemplate
- .. _Travis-CI: https://travis-ci.org/python-hyper/uritemplate
- .. _URI Templates: https://tools.ietf.org/html/rfc6570
- .. _license: https://github.com/python-hyper/uritemplate/blob/master/LICENSE
|
