This repository has been archived by the owner on Sep 28, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #40 from brandicted/develop
release 0.3.0
- Loading branch information
Showing
63 changed files
with
4,602 additions
and
966 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# Config file for automatic testing at travis-ci.org | ||
language: python | ||
python: | ||
- "2.7" | ||
install: "pip install -r requirements.dev" | ||
script: py.test | ||
env: | ||
- TOXENV=py27 | ||
install: | ||
- pip install tox | ||
script: tox |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
# `Nefertari` | ||
[![Build Status](https://travis-ci.org/brandicted/nefertari.svg?branch=master)](https://travis-ci.org/brandicted/nefertari) | ||
[![Documentation Status](https://readthedocs.org/projects/nefertari/badge/?version=master)](https://readthedocs.org/projects/nefertari/?badge=master) | ||
[![Documentation Status](https://readthedocs.org/projects/nefertari/badge/?version=master)](http://nefertari.readthedocs.org/en/master/) | ||
|
||
Nefertari is a REST API framework sitting on top of [Pyramid](https://github.com/Pylons/pyramid) and [ElasticSearch](https://www.elastic.co/downloads/elasticsearch). She currently offers two backend engines: [SQLA](https://github.com/brandicted/nefertari-sqla) and [MongoDB](https://github.com/brandicted/nefertari-mongodb). | ||
|
||
You can read the documentation on [readthedocs](https://nefertari.readthedocs.org/en/latest/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
0.2.1 | ||
0.3.0 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
Authentication & Security | ||
========================= | ||
|
||
Set `auth = true` in you .ini file to enable authentication. | ||
|
||
Ticket Auth | ||
----------- | ||
|
||
Nefertari currently supports the default Pyramid "auth ticket" cookie method of authentication. | ||
|
||
Token Auth | ||
---------- | ||
|
||
(under development) | ||
|
||
Visible fields in views | ||
----------------------- | ||
|
||
You can control which fields to display to both authenticated users and unauthenticated users by defining `_auth_fields` and `_public_fields` respectively in your models. | ||
|
||
ACL API | ||
------- | ||
|
||
For authorizing access to specific resources, Nefertari uses standard Pyramid access control lists. `See the documentation on Pyramid ACLs <http://docs.pylonsproject.org/projects/pyramid/en/1.5-branch/narr/security.html>`_ to understand how to extend and customize them. | ||
|
||
.. automodule:: nefertari.acl | ||
:members: | ||
|
||
CORS | ||
---- | ||
|
||
To enable CORS headers, set the following lines in your .ini file: | ||
|
||
.. code-block:: ini | ||
cors.enable = true | ||
cors.allow_origins = http://localhost | ||
cors.allow_credentials = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,21 @@ | ||
Changelog | ||
========= | ||
|
||
* :release:`0.3.0 <2015-05-18>` | ||
* :support:`-` Step-by-step 'Getting started' guide | ||
* :bug:`- major` Fixed several issues related to ElasticSearch indexing | ||
* :support:`-` Increased test coverave | ||
* :feature:`-` Added ability to PATCH/DELETE collections | ||
* :feature:`-` Implemented API output control by field (apply_privacy wrapper) | ||
|
||
* :release:`0.2.1 <2015-04-21>` | ||
* :support:`0` Specify any field as primary, and have it respected by all relations endpoints. | ||
* :feature:`0` Added DictField type. | ||
* :support:`0` URL parsing for DictField and ListField values with _m=VERB options. | ||
* :bug:`-` Fixed URL parsing for DictField and ListField values with _m=VERB options | ||
|
||
* :release:`0.2.0 <2015-04-07>` | ||
* :feature:`0` Added script to index Elasticsearch models. | ||
* :feature:`0` Started adding tests. | ||
* :support:`0` Listing on PyPI. | ||
* :support:`0` Improved docs. | ||
* :feature:`-` Added script to index Elasticsearch models | ||
* :feature:`-` Started adding tests | ||
* :support:`-` Listing on PyPI | ||
* :support:`-` Improved docs | ||
|
||
* :release:`0.1.1 <2015-04-01>` | ||
* :support:`0` Initial release after two years of development as "Presto". Now with database engines! Originally extracted and generalized from the Brandicted API which only used MongoDB. | ||
* :support:`-` Initial release after two years of development as "Presto". Now with database engines! Originally extracted and generalized from the Brandicted API which only used MongoDB. |
Oops, something went wrong.