Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marrow/web.dispatch

Core utilities related to endpoint dispatch.
https://github.com/marrow/web.dispatch

Last synced: about 2 months ago
JSON representation

Core utilities related to endpoint dispatch.

Awesome Lists containing this project

README 

        
============

web.dispatch

============



    © 2009-2019 Alice Bevan-McGregor and contributors.



..



    https://github.com/marrow/web.dispatch



..



    |latestversion| |ghtag| |downloads| |masterstatus| |mastercover| |masterreq| |ghwatch| |ghstar|



Introduction

============



Dispatch is the process of taking some starting point and a path, then resolving the object that path refers to. This

process is common to almost every web application framework (transforming URLs into controllers), RPC system, and even

filesystem shell. Other terms for this process include: "traversal", "routing", or "lookup".



This package speaks a standardized `dispatch protocol `_ and

is not entirely intended for direct use by most developers. The target audience is instead the authors of frameworks

that may require such modular dispatch for use by their own users.



Installation

============



Installing ``web.dispatch`` is easy, just execute the following in a terminal::



    pip install web.dispatch



**Note:** We *strongly* recommend always using a container, virtualization, or sandboxing environment of some kind when

developing using Python; installing things system-wide is yucky (for a variety of reasons) nine times out of ten.  We

prefer light-weight `virtualenv `_, others prefer solutions as

robust as `Vagrant `_.



If you add ``web.dispatch`` to the ``install_requires`` argument of the call to ``setup()`` in your

application's ``setup.py`` file, this dispatcher will be automatically installed and made available when your own

application or library is installed.  We recommend using "less than" version numbers to ensure there are no

unintentional side-effects when updating.  Use ``web.dispatch<3.1`` to get all bugfixes for the current release,

and ``web.dispatch<4.0`` to get bugfixes and feature updates while ensuring that large breaking changes are not

installed.



Development Version

-------------------



    |developstatus| |developcover| |ghsince| |issuecount| |ghfork|



Development takes place on `GitHub `_ in the 

`web.dispatch `_ project.  Issue tracking, documentation, and

downloads are provided there.



Installing the current development version requires `Git `_, a distributed source code management

system.  If you have Git you can run the following to download and *link* the development version into your Python

runtime::



    git clone https://github.com/marrow/web.dispatch.git

    pip install -e 'web.dispatch[development]'



You can then upgrade to the latest version at any time::



    (cd web.dispatch; git pull; pip install -e '.[development]')



If you would like to make changes and contribute them back to the project, fork the GitHub project, make your changes,

and submit a pull request.  This process is beyond the scope of this documentation; for more information see

`GitHub's documentation `_.



Version History

===============



Version 3.0

-----------



* First version. Numbering kept parallel with primary dispatchers.



License

=======



web.dispatch has been released under the MIT Open Source license.



The MIT License

---------------



Copyright © 2009-2019 Alice Bevan-McGregor and contributors.



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated

documentation files (the “Software”), to deal in the Software without restriction, including without limitation the

rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit

persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the

Software.



THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.



.. |ghwatch| image:: https://img.shields.io/github/watchers/marrow/web.dispatch.svg?style=social&label=Watch

    :target: https://github.com/marrow/web.dispatch/subscription

    :alt: Subscribe to project activity on Github.



.. |ghstar| image:: https://img.shields.io/github/stars/marrow/web.dispatch.svg?style=social&label=Star

    :target: https://github.com/marrow/web.dispatch/subscription

    :alt: Star this project on Github.



.. |ghfork| image:: https://img.shields.io/github/forks/marrow/web.dispatch.svg?style=social&label=Fork

    :target: https://github.com/marrow/web.dispatch/fork

    :alt: Fork this project on Github.



.. |masterstatus| image:: http://img.shields.io/travis/marrow/web.dispatch/master.svg?style=flat

    :target: https://travis-ci.org/marrow/web.dispatch/branches

    :alt: Release build status.



.. |mastercover| image:: http://img.shields.io/codecov/c/github/marrow/web.dispatch/master.svg?style=flat

    :target: https://codecov.io/github/marrow/web.dispatch?branch=master

    :alt: Release test coverage.



.. |masterreq| image:: https://img.shields.io/requires/github/marrow/web.dispatch.svg

    :target: https://requires.io/github/marrow/web.dispatch/requirements/?branch=master

    :alt: Status of release dependencies.



.. |developstatus| image:: http://img.shields.io/travis/marrow/web.dispatch/develop.svg?style=flat

    :target: https://travis-ci.org/marrow/web.dispatch/branches

    :alt: Development build status.



.. |developcover| image:: http://img.shields.io/codecov/c/github/marrow/web.dispatch/develop.svg?style=flat

    :target: https://codecov.io/github/marrow/web.dispatch?branch=develop

    :alt: Development test coverage.



.. |developreq| image:: https://img.shields.io/requires/github/marrow/web.dispatch.svg

    :target: https://requires.io/github/marrow/web.dispatch/requirements/?branch=develop

    :alt: Status of development dependencies.



.. |issuecount| image:: http://img.shields.io/github/issues-raw/marrow/web.dispatch.svg?style=flat

    :target: https://github.com/marrow/web.dispatch/issues

    :alt: Github Issues



.. |ghsince| image:: https://img.shields.io/github/commits-since/marrow/web.dispatch/3.0.0.svg

    :target: https://github.com/marrow/web.dispatch/commits/develop

    :alt: Changes since last release.



.. |ghtag| image:: https://img.shields.io/github/tag/marrow/web.dispatch.svg

    :target: https://github.com/marrow/web.dispatch/tree/2.1.0

    :alt: Latest Github tagged release.



.. |latestversion| image:: http://img.shields.io/pypi/v/web.dispatch.svg?style=flat

    :target: https://pypi.python.org/pypi/web.dispatch

    :alt: Latest released version.



.. |downloads| image:: http://img.shields.io/pypi/dw/web.dispatch.svg?style=flat

    :target: https://pypi.python.org/pypi/web.dispatch

    :alt: Downloads per week.



.. |cake| image:: http://img.shields.io/badge/cake-lie-1b87fb.svg?style=flat