Adam Hopkins
4d527035ae
Add dotted endpoint notation and additional tests
2018-12-31 13:40:07 +02:00
Jotagê Sales
b36dc22b45
resolve conflict in setup.py
2018-12-28 12:08:10 -02:00
Harsha Narayana
15b1c875f5
fix minor type and pip install instruction mismatch
2018-12-28 11:32:30 +05:30
Harsha Narayana
de8c37ad00
fix pip install typo in contribution page
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:24:03 +05:30
Harsha Narayana
a80499c4b7
update installation steps to be consistent across documentation and readme
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:24:03 +05:30
Harsha Narayana
82f7f847ba
cleanup requirements and move dependency inside setup.py
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:24:03 +05:30
Harsha Narayana
2d82b8951f
make release script black compliant and tweak documentation with indexing and format
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:24:02 +05:30
Harsha Narayana
b7702bc3e8
add monitoring examples and documents
2018-12-28 10:22:28 +05:30
Harsha Narayana
efa77cf5ec
add api documentation for router and server
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:22:28 +05:30
Harsha Narayana
f6355bd075
add additional examples to documentation
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:22:28 +05:30
Harsha Narayana
939b5ea095
update copyright date and add example section with category
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:22:28 +05:30
Harsha Narayana
1623d397be
categorize the sanic extensions list
...
Signed-off-by: Harsha Narayana <harsha2k4@gmail.com>
2018-12-28 10:22:27 +05:30
7
67d51f7e1b
Merge pull request #1423 from yunstanford/request-streaming-support
...
basic request streaming support with flow control
2018-12-27 18:06:02 -08:00
JeongKyungSeo
ada5918bc8
Fix typo in exceptions.md
2018-12-27 16:11:37 +09:00
Jotagê Sales
19b304b0fc
fix doc
2018-12-26 18:31:43 -02:00
Jotagê Sales
0b64fe6746
create a documentation for config path
2018-12-26 18:27:02 -02:00
Omar Ryhan
d2670664ba
Update exceptions.md ( #1431 )
...
Documented error handling from ``app.error_handler.add``
Documented custom error handling by subclassing.
2018-12-22 09:21:03 -06:00
Yun Xu
1bfbc67c62
expose request_buffer_queue_size to be configurable and update documentation
...
fix StreamBuffer buffer_size
2018-12-04 20:21:00 -08:00
Yun Xu
fca7cb9fb0
update request streaming doc
2018-12-03 22:51:09 -08:00
jacob
1a59614f79
Add stream_large_files and host examples in static_file document
2018-11-20 14:28:08 +08:00
Tim&Anna
096c44b910
Update extensions.md ( #1263 )
...
* Update extensions.md
add an extension: sanic-script
* Update extensions.md
2018-11-14 07:16:43 -06:00
Lewis
90b9d73244
ADD: Sanic-JWT-Extended extension
2018-11-13 14:39:29 +09:00
jacob
dd5bac61cb
Update document for logging
2018-11-12 16:09:12 +08:00
jacob
3e3bce422e
Add test for sanic.root logger and update the docs of logging
2018-11-06 21:27:01 +08:00
Stephen Sadowski
f13f451084
Merge pull request #1385 from lixxu/master
...
update doc for latest blueprint code
2018-11-05 07:40:12 -06:00
Adam Hopkins
ba46aff069
Resolve build of latex documentation relating to markdown lists
2018-10-30 22:39:17 +02:00
lixxu
7a65471ba5
update doc for latest blueprint code
2018-10-29 16:54:34 +08:00
Adam Hopkins
c708e8425f
Fix documentation build errors
2018-10-26 11:57:28 +03:00
Stephen Sadowski
a20ad99638
Added documentation for AF_INET6 and AF_UNIX socket usage
2018-10-19 13:33:01 -05:00
Lewis
a16842f7bc
Fix missing quotes in decorator example
2018-10-08 18:59:15 +09:00
Hasan Ramezani
1fe7306af8
Add missed documentation for config section.
2018-10-07 01:32:36 +02:00
Ashley Sommer
30e6a310f1
Pausable response streams ( #1179 )
...
* This commit adds handlers for the asyncio/uvloop protocol callbacks for pause_writing and resume_writing.
These are needed for the correct functioning of built-in tcp flow-control provided by uvloop and asyncio.
This is somewhat of a breaking change, because the `write` function in user streaming callbacks now must be `await`ed.
This is necessary because it is possible now that the http protocol may be paused, and any calls to write may need to wait on an async event to be called to become unpaused.
Updated examples and tests to reflect this change.
This change does not apply to websocket connections. A change to websocket connections may be required to match this change.
* Fix a couple of PEP8 errors caused by previous rebase.
* update docs
add await syntax to response.write in response-streaming docs.
* remove commented out code from a test file
2018-08-18 18:12:13 -07:00
Innokenty Lebedev
1814ff05f4
Add sse extension ( #1288 )
2018-08-16 11:59:58 -07:00
Adam Hopkins
e1c9020268
Update extensions.md ( #1205 )
...
Changing the description of [Sanic JWT](https://github.com/ahopkins/sanic-jwt ) to include permission scoping
2018-04-29 18:41:17 -07:00
Philip Xu
04a12b436e
Added Sanic-Auth, Sanic-CookieSession and Sanic-WTF to Extensions doc ( #1210 )
2018-04-29 18:40:18 -07:00
Fantix King
818a8c2196
Added GINO to Extensions doc ( #1200 )
2018-04-21 21:02:49 -07:00
Arnulfo Solís
b6715464fd
added init docs ( #1167 )
2018-04-01 20:53:08 -07:00
Charles-Axel Dein
3dfb31b1b9
Clarify arguments to request/response middleware
2018-03-21 12:07:26 +01:00
Raphael Deem
7f36d20123
Merge pull request #1145 from yingshaoxo/patch-1
...
add an necessary import for better understanding
2018-02-28 01:19:29 -08:00
Sun Wei
23ea0b7ec9
exception.md code sample miss 'async' prefix
2018-02-26 16:09:26 +08:00
yingshaoxo
ef26cb283b
add an necessary import for better understanding
...
add `from sanic.response import redirect`
2018-02-26 11:24:54 +08:00
Raphael Deem
36f12c822f
Merge pull request #1122 from knowsuchagency/master
...
add app.register_listener method
2018-02-15 16:58:27 -08:00
panxb
e735fe54c3
raw requires a bytes-like object
...
raw requires a bytes-like object, or an object that implements __bytes__, not 'str'
2018-02-15 00:11:37 +08:00
Stephan Fitzpatrick
e911e2e1df
updated doc
2018-02-13 23:58:03 -08:00
Yun Xu
dfc2166d8b
add websocket.rst to index.rst
2018-02-10 12:21:23 -08:00
Yun Xu
2b70346db4
fix doc
2018-02-09 21:32:09 -08:00
Yun Xu
090df6f224
add websocket section in doc
2018-02-09 21:26:39 -08:00
SirEdvin
37eb2c1db6
Provide information about sanic-oauth extension
2018-01-27 10:28:53 +02:00
caitinggui
ec4339bd47
update description
2018-01-24 09:02:07 +08:00
caitinggui
4036f1c121
update class_based_views
2018-01-19 16:20:07 +08:00
Raphael Deem
22ad697d1f
Merge pull request #1078 from eltrhn/master
...
Add support for blueprint groups and nesting
2018-01-18 17:26:52 -08:00
Eli
a10d7469cd
Add blueprint groups + nesting
2018-01-18 17:20:51 -08:00
Matt Fox
9677158b75
Add request.method to documentation
2018-01-17 07:31:39 -08:00
Raphael Deem
c91a806774
udpate docs with add_task app injection
2017-12-28 01:59:16 -08:00
Dan Palmer
10a378bd46
Typo
2017-12-11 14:33:43 +00:00
Raphael Deem
63bbcb5152
Merge branch 'master' into 977
2017-10-25 22:18:25 -07:00
Raphael Deem
c2191153cf
remove port from ip
2017-10-23 21:37:59 -07:00
Ashley Sommer
49f3ba39f9
Add Sanic-Plugins-Framework library to Extensions doc
...
I made a new tool for devs to use for easily and quickly creating Sanic Plugins (extensions), and for application builders to easily use those plugins in their app.
2017-10-18 17:52:03 +10:00
Raphael Deem
9150767574
add blueprint name to request.endpoint
2017-10-16 23:25:37 -07:00
Raphael Deem
75f2180cb1
add handler name to request as endpoint
2017-10-16 22:43:40 -07:00
Ashley Sommer
477e6b8663
Add documentation for REQUEST_TIMEOUT, RESPONSE_TIMEOUT and KEEP_ALIVE_TIMEOUT config values.
...
Fixed some inconsistent default values.
2017-10-16 10:53:45 +10:00
Yun Xu
225ea49b6f
resolve conflicts again
2017-10-01 01:22:27 -07:00
Raphael Deem
2fb4697e12
Merge pull request #952 from ahopkins/patch-1
...
Update extensions.md
2017-09-29 18:33:30 -07:00
lanf0n
62871ec9b3
add sphinx extension to add asyncio-specific markups
2017-09-30 01:16:26 +08:00
Adam Hopkins
91b2167eba
Update extensions.md
...
Add - [JWT](https://github.com/ahopkins/sanic-jwt ): Authentication extension for JSON Web Tokens (JWT) extension package.
2017-09-27 11:07:06 +03:00
Yun Xu
0b23f4ff81
resolve conflicts
2017-09-23 06:19:09 -07:00
Kuzma Leshakov
c836441a75
Update getting_started.md
...
Hello World example at the main Readme file (https://github.com/channelcat/sanic/blob/master/README.rst ) is different, it returns json. Here is returned text. In the following examples, such as Routing (http://sanic.readthedocs.io/en/latest/sanic/routing.html ) is again used json. Therefore I suggest to make examples the same, having json as output
2017-09-18 11:37:32 +03:00
Yun Xu
730f7c5e41
add doc for customizing logging config
2017-09-13 18:30:38 -07:00
Yun Xu
5cabc9cff2
update doc
2017-09-13 18:16:58 -07:00
Yun Xu
ddc039ed2e
update doc
2017-09-13 18:14:46 -07:00
Raphael Deem
d8c8ccd180
Merge pull request #932 from lixxu/master
...
static files url building using url_for
2017-09-12 12:59:04 -07:00
Anatoly Ivanov
73c04f5a89
Added information on request.token
...
The manual lacked info about request.token, which keeps authorization data. See https://github.com/channelcat/sanic/blob/master/sanic/request.py#L84 for details
2017-09-08 14:21:49 +03:00
lixxu
195f707f14
missing '/' in doc
2017-09-06 19:19:59 +08:00
lixxu
bc20dc5c62
use url_for for url building for static files
2017-09-06 19:17:52 +08:00
Tim Mundt
97d8b9e908
documentation for env var prefix; allow passing in the prefix through the app constructor
2017-09-05 10:41:55 +02:00
lixxu
762b2782ee
use name to define route name for different methods on same url
2017-08-22 14:02:38 +08:00
lixxu
eab809d410
add name option for route building
2017-08-21 18:05:34 +08:00
Raphael Deem
fa1a95ae91
Merge pull request #900 from yunstanford/patch-default-strict-slashes
...
Patch default strict slashes
2017-08-21 00:31:42 -07:00
Yun Xu
63babae63d
add doc
2017-08-21 00:28:01 -07:00
Igor Hatarist
439ff11d13
Added a line on headers in the "Request Data" docs
2017-08-20 19:28:09 +03:00
pkuphy
a55efc832d
fix typo
2017-08-19 01:03:54 +08:00
dongweiming
2587f6753d
Fix blueprint doc
2017-08-15 22:04:25 +08:00
7
9b3fbe4593
fixed small doc issue ( #877 )
2017-08-02 10:15:18 -07:00
Karolis Mažukna
621343112d
Fix typo in documentation
2017-07-25 13:29:17 +03:00
Yun Xu
f34226425e
add jinja2-sanic
2017-07-22 18:41:53 -07:00
Raphael Deem
4265ad5f23
add versioning
2017-07-12 22:19:42 -07:00
Raphael Deem
8aafd72ef0
Merge branch 'auto-doc' of https://github.com/yunstanford/sanic
2017-07-12 20:19:30 -07:00
Stefane Fermigier
04ff393875
Add missing code block qualifier
2017-07-10 22:11:12 +02:00
Yun Xu
5d00717f39
improve doc and remove warnings
2017-07-02 10:02:04 -07:00
Yun Xu
3fff685c44
add auto-doc support
2017-07-01 23:46:34 -07:00
Eli Uriegas
b6ac3ef445
Merge pull request #826 from yunstanford/pytest-sanic
...
Pytest sanic
2017-06-30 18:17:15 -07:00
François KUBLER
021e9b228a
Fixed a small error : Sanic.__init__ doesn't have a load_vars parameter.
...
It is `load_env`.
2017-06-30 16:24:41 +02:00
Yun Xu
fd5faeb5dd
add an example
2017-06-29 09:14:21 -07:00
Yun Xu
e7c8035ed7
add pytest-sanic
2017-06-29 09:06:17 -07:00
Jonas Obrist
412ffd1592
Added a warning to the cookies documentation about security
2017-06-28 11:05:59 +09:00
7
f049a4ca67
Recycling gunicorn worker ( #800 )
...
* add recycling feature to gunicorn worker
* add unit tests
* add more unit tests, and remove redundant trigger_events call
* fixed up unit tests
* make flake8 happy
* address feedbacks
* make flake8 happy
* add doc
2017-06-22 13:26:50 -07:00
Yun Xu
566a6369a5
add sanic-transmute
2017-06-07 20:27:54 -07:00
Matthew Snyder
735b8665f1
Small logging docs fixes
2017-06-05 10:42:17 -07:00
Raphael Deem
23cb39b557
Merge pull request #744 from algtmatt/feature/from_file_doc_fix
...
Update config file loader docs
2017-05-24 18:16:10 -07:00
Eli Uriegas
48de321869
Merge pull request #697 from 38elements/stream
...
Add Request.stream
2017-05-24 16:22:52 -07:00
Matthew Snyder
57c1838f68
Update config file loader docs
2017-05-22 14:10:08 -07:00
Raphael Deem
4b80ffb9eb
Merge pull request #740 from r0fls/739
...
add abort function
2017-05-21 02:20:02 -07:00
Raphael Deem
9efa7c116d
remove redundant code; decode response
2017-05-20 23:27:00 -07:00
Raphael Deem
d3b6208057
add abort function
2017-05-19 18:52:19 -07:00
Raphael Deem
0858d3c544
Merge pull request #733 from ashleysommer/file_stream
...
Add file_stream response handler
2017-05-19 16:48:12 -07:00
38elements
848a5c61f0
Fix Running via Gunicorn in deploying.md
2017-05-19 23:22:57 +09:00
ashleysommer
181977ad4e
Added brief documentation with an example for file_stream
...
Added test to ensure `file_stream()` works in the test suite.
2017-05-18 18:12:26 +10:00
suoning
dddce3f30d
update logging, Remove the comments
2017-05-15 13:59:03 +08:00
suoning
68d4bb6ffe
update logging doc
2017-05-15 10:54:30 +08:00
suoning
a27471178a
update logger doc
2017-05-15 10:25:19 +08:00
38elements
a50d8421b8
Add heading in streaming.md
2017-05-11 19:18:58 +09:00
messense
c3683662c2
Remove timedRotatingFile log config
2017-05-11 11:18:59 +08:00
Jeremy Zimmerman
18930082e2
spelling mistake
...
fixed incorrect spelling
2017-05-10 09:38:57 -07:00
38elements
6a14e49479
Replace stream decorator to stream parameter
2017-05-09 22:31:15 +09:00
Eli Uriegas
bb6de53f28
Fix docs
2017-05-08 20:44:19 -07:00
Eli Uriegas
bfcd499cc2
Remove default_filter module, put into logging
2017-05-08 20:41:34 -07:00
Eli Uriegas
1fb640c313
Fix camel case module
2017-05-08 20:36:57 -07:00
38elements
15ad07f03d
Fix streaming.md
2017-05-08 00:10:36 +09:00
38elements
0b53c413a7
Add stream decorator for HTTPMethodView
2017-05-07 21:33:15 +09:00
38elements
931397c7e1
Add stream for CompositionView
2017-05-07 18:38:48 +09:00
38elements
ef2cc7ebf5
Add Request.stream
2017-05-07 18:38:48 +09:00
38elements
25037006bf
Remove utils.py
2017-05-04 15:52:18 +09:00
Raphael Deem
23b4b20b4f
document create_server method
2017-05-02 22:44:42 -07:00
Jeremy Zimmerman
1bf06312b8
misspelling
...
acutal -> actual
2017-05-01 17:07:38 -07:00
38elements
e65f08a2c8
Fix docs/sanic/routing.md
2017-04-30 22:03:16 +09:00
banteg
7754bb995b
expose matched request uri template
2017-04-29 02:39:56 +07:00
zenix
63a27cc5e2
add document on logging
2017-04-26 14:50:21 +09:00
Raphael Deem
81b6d988ec
NO_KEEP_ALIVE -> KEEP_ALIVE
2017-04-16 22:43:49 -07:00
Raphael Deem
6f098b3d21
add no_keep_alive setting to docs
2017-04-16 22:05:34 -07:00
Eli Uriegas
2c45c2d3c0
Add new contributing rules
2017-04-14 14:35:28 -05:00
Raphael Deem
93cb7582c2
Merge branch 'master' into prom
2017-04-04 11:06:32 -07:00
Dan Kruchinin
d418b03708
Add prometheus extension
2017-04-04 14:22:31 +01:00
Ashley Sommer
765e90ecfa
update extensions
...
Add Sanic-RestPlus!
2017-04-04 13:40:59 +10:00
Eli Uriegas
62ebcba647
Add graphql integration extension
...
Closes #579
2017-04-03 14:45:18 -05:00
monobot
25edbe6805
update docs
2017-04-02 02:28:16 +01:00
nosaevb
fcd8e5e5ad
Typo Fix in docs/sanic/cookies.md
2017-03-30 23:02:46 +01:00
Eli Uriegas
511998d8e1
Merge pull request #573 from r0fls/env-config
...
allow setting config from individual env variables
2017-03-28 22:24:37 -05:00
Raphael Deem
1787f8617f
Merge pull request #592 from weargoggles/patch-1
...
Document synchronous response.write in streaming
2017-03-27 20:14:20 -07:00
Raphael Deem
724c03630a
Update extensions.md
2017-03-26 11:49:15 -07:00
itiel
b00b2561e5
add sanic-nginx-docker-example to extensions.md
2017-03-26 21:16:03 +03:00
Raphael Deem
c5b50fe3cf
allow setting config from individual env variables
2017-03-25 17:45:55 -07:00
Pete Wildsmith
65ae7669f9
Document synchronous response.write in streaming
...
The Streaming section of the docs was updated to make clear that a synchronous write should be used in the callback, but this section was not updated.
2017-03-24 10:11:30 +00:00
Raphael Deem
536140340e
Merge pull request #585 from subyraman/listener-docs
...
add docs for server lifecycle listeners and `add_task`
2017-03-23 18:38:48 -07:00
Suby Raman
6188891a53
add-listeners-docs
2017-03-23 15:49:23 -04:00
Raphael Deem
563bc34fb5
Merge pull request #578 from messense/feature/gunicorn-deploy-doc
...
Add documentation for Gunicorn worker
2017-03-23 12:20:00 -07:00
Suby Raman
b776c37b36
add decorator docs
2017-03-23 15:16:46 -04:00
messense
3d9927dee0
Add documentation for Gunicorn worker
2017-03-23 09:12:23 +08:00
Shawn Niederriter
a379ef6781
Added Sanic-OAuth to extensions.
2017-03-18 23:56:11 -04:00
lixxu
94c83c445f
fix broken table
2017-03-17 14:01:54 +08:00
lixxu
625865412f
update function name as it not halt request actually
2017-03-17 13:12:17 +08:00
