Cliquet
Rationale
Philosophy
Features
Records and synchronization
Generic endpoints
Toolkit
Dependencies
Built with Cliquet
Context
Vision
General
Generic storage
Roadmap
Similar projects
Getting started
Installation
Start a Pyramid project
Include Cliquet
Run!
Authentication
Define resources
Schema validation
What’s next ?
Configuration
Resource customization
Advanced initialization
Beyond Cliquet
API Endpoints
API versioning
Authentication
Basic Auth
OAuth Bearer token
Firefox Accounts
Resource endpoints
GET /{collection}
Filtering
Sorting
Counting
Polling for changes
Paginate
List of available URL parameters
HTTP Status Codes
POST /{collection}
Validation
Conflicts
HTTP Status Codes
DELETE /{collection}
HTTP Status Codes
GET /{collection}/<id>
HTTP Status Code
DELETE /{collection}/<id>
HTTP Status Code
PUT /{collection}/<id>
HTTP Status Code
PATCH /{collection}/<id>
Read-only fields
Conflicts
HTTP Status Code
Protected resources
Batch operations
POST /batch
HTTP Status Codes
Pros & Cons
Utility endpoints for OPS and Devs
GET /
GET /__heartbeat__
Server timestamps
Cache control
Concurrency control
Backoff indicators
Backoff header on heavy load
Retry-After indicators
Error responses
Protocol description
Error codes
Precondition errors
Conflict errors
Validation errors
Deprecation
Reference
Installation
Supported Python versions
Distribute & Pip
Python 3.4
Linux
OS X
Cryptography libraries
Linux
OS X
Install Redis
Linux
OS X
Install PostgreSQL
Client libraries only
Full server
Server using Docker
Configuration
Environment variables
Project info
Feature settings
Disabling endpoints
Deployment
Scheme, host and port
Deprecation
Logging with Heka
Handling exceptions with Sentry
Monitoring with StatsD
Monitoring with New Relic
Storage
Cache
Authentication
Authentication setup
Basic Auth
Custom Authentication
Firefox Accounts
Permission configuration
Application profiling
Enable middleware
Initialization sequence
Resource
Full example
Resource Schema
Resource class
Interaction with storage
Custom record ids
Generators objects
Custom Usage
Within views
Outside views
Viewsets
Configuring a viewset
Subclassing a viewset
ViewSet class
Storage
Backends
PostgreSQL
Redis
Memory
Cloud Storage
API
Exceptions
Store custom data
Cache
PostgreSQL
Redis
Memory
API
Permissions
Glossary
Overview
Route factory
Authorization policy
Permissions backend
Errors
Glossary
Ecosystem
Packages
Extending Cliquet
Pluggable components
Include external packages
Include me
Configuration
Custom backend
Adding features
JavaScript client
Contributing
Setup your development environment
OS X
Run tests
Run a single test
Definition of done
IRC channel
Changelog
2.3.1 (2015-07-15)
2.3 (2015-07-13)
2.2.1 (2015-07-06)
2.2.0 (2015-07-02)
2.1.0 (2015-06-26)
2.0.0 (2015-06-16)
1.8.0 (2015-05-13)
1.7.0 (2015-04-10)
1.6.0 (2015-03-30)
1.5.0 (2015-03-27)
1.4.1 (2015-03-25)
1.4.0 (2015-03-24)
1.3.2 (2015-03-20)
1.3.1 (2015-03-20)
1.3.0 (2015-03-20)
1.2.1 (2015-03-18)
1.2 (2015-03-18)
1.1.4 (2015-03-03)
1.1.3 (2015-03-03)
1.1.2 (2015-03-03)
1.1.1 (2015-03-03)
1.1 (2015-03-03)
1.0 (2015-03-02)
Contributors
Cliquet
Docs
»
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
Access Control Entity
Access Control List
ACE
ACEs
ACL
ACLs
add_principal_to_ace() (cliquet.permission.PermissionBase method)
add_user_principal() (cliquet.permission.PermissionBase method)
apply_changes() (cliquet.resource.BaseResource method)
AuthorizationPolicy (class in cliquet.authorization)
auto_now (cliquet.schema.TimeStamp attribute)
B
BackendError
BaseResource (class in cliquet.resource)
C
CacheBase (class in cliquet.cache)
check_permission() (cliquet.permission.PermissionBase method)
cliquet.errors (module)
cliquet.schema (module)
cliquet.storage (module)
cliquet.storage.exceptions (module)
cliquet.storage.generators (module)
Collection (class in cliquet.resource)
collection_delete() (cliquet.resource.BaseResource method)
collection_get() (cliquet.resource.BaseResource method)
collection_post() (cliquet.resource.BaseResource method)
collection_timestamp() (cliquet.storage.StorageBase method)
create() (cliquet.storage.StorageBase method)
create_record() (cliquet.resource.Collection method)
CRUD
D
default_viewset (cliquet.resource.BaseResource attribute)
delete() (cliquet.cache.CacheBase method)
(cliquet.resource.BaseResource method)
(cliquet.storage.StorageBase method)
delete_all() (cliquet.storage.StorageBase method)
delete_record() (cliquet.resource.Collection method)
delete_records() (cliquet.resource.Collection method)
deleted_field (cliquet.resource.Collection attribute)
direction (cliquet.storage.Sort attribute)
E
endpoint
ERRORS (in module cliquet.errors)
expire() (cliquet.cache.CacheBase method)
extensible
F
field (cliquet.storage.Filter attribute)
(cliquet.storage.Sort attribute)
Filter (class in cliquet.storage)
Firefox Accounts
flush() (cliquet.cache.CacheBase method)
(cliquet.permission.PermissionBase method)
(cliquet.storage.StorageBase method)
G
Generator (class in cliquet.storage.generators)
get() (cliquet.cache.CacheBase method)
(cliquet.resource.BaseResource method)
(cliquet.storage.StorageBase method)
get_all() (cliquet.storage.StorageBase method)
get_name() (cliquet.resource.ViewSet method)
get_parent_id() (cliquet.resource.BaseResource method)
get_record() (cliquet.resource.Collection method)
get_record_schema() (cliquet.resource.ViewSet method)
get_records() (cliquet.resource.Collection method)
get_service_name() (cliquet.resource.ViewSet method)
get_view() (cliquet.resource.ViewSet method)
get_view_arguments() (cliquet.resource.ViewSet method)
H
http_error() (in module cliquet.errors)
I
id_field (cliquet.resource.Collection attribute)
initialize() (in module cliquet)
initialize_schema() (cliquet.cache.CacheBase method)
(cliquet.permission.PermissionBase method)
(cliquet.storage.StorageBase method)
is_endpoint_enabled() (cliquet.resource.ViewSet method)
is_known_field() (cliquet.resource.BaseResource method)
is_readonly() (cliquet.schema.ResourceSchema method)
J
json_error_handler() (in module cliquet.errors)
K
KISS
M
mapping (cliquet.resource.BaseResource attribute)
match() (cliquet.storage.generators.Generator method)
Memory (class in cliquet.cache.memory)
(class in cliquet.storage.memory)
missing (cliquet.schema.TimeStamp attribute)
modified_field (cliquet.resource.Collection attribute)
O
object
object_permission_authorized_principals() (cliquet.permission.PermissionBase method)
object_permission_principals() (cliquet.permission.PermissionBase method)
objects
operator (cliquet.storage.Filter attribute)
P
patch() (cliquet.resource.BaseResource method)
permission
PermissionBase (class in cliquet.permission)
permissions
PermissionsSchema (class in cliquet.schema)
ping() (cliquet.cache.CacheBase method)
(cliquet.permission.PermissionBase method)
(cliquet.storage.StorageBase method)
pluggable
PostgreSQL (class in cliquet.cache.postgresql)
(class in cliquet.storage.postgresql)
preserve_unknown (cliquet.schema.ResourceSchema.Options attribute)
principal
principals
process_record() (cliquet.resource.BaseResource method)
put() (cliquet.resource.BaseResource method)
R
raise_invalid() (in module cliquet.errors)
readonly_fields (cliquet.schema.ResourceSchema.Options attribute)
RecordNotFoundError
Redis (class in cliquet.cache.redis)
(class in cliquet.storage.redis)
regexp (cliquet.storage.generators.Generator attribute)
(cliquet.storage.generators.UUID4 attribute)
remove_principal_from_ace() (cliquet.permission.PermissionBase method)
remove_user_principal() (cliquet.permission.PermissionBase method)
resource
ResourceSchema (class in cliquet.schema)
ResourceSchema.Options (class in cliquet.schema)
RouteFactory (class in cliquet.authorization)
S
schema_type (cliquet.schema.TimeStamp attribute)
(cliquet.schema.URL attribute)
set() (cliquet.cache.CacheBase method)
Sort (class in cliquet.storage)
StorageBase (class in cliquet.storage)
T
TimeStamp (class in cliquet.schema)
timestamp() (cliquet.resource.Collection method)
title (cliquet.schema.TimeStamp attribute)
ttl() (cliquet.cache.CacheBase method)
U
UnicityError
unique_fields (cliquet.schema.ResourceSchema.Options attribute)
update() (cliquet.resource.ViewSet method)
(cliquet.storage.StorageBase method)
update_record() (cliquet.resource.Collection method)
URL (class in cliquet.schema)
user id
user identifier
user identifiers
user_principals() (cliquet.permission.PermissionBase method)
UUID4 (class in cliquet.storage.generators)
V
value (cliquet.storage.Filter attribute)
ViewSet (class in cliquet.resource)
Read the Docs
v: 2.3.1
Versions
latest
2.3.1
2.2.1
2.0.0
1.8.0
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.