Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

Commit

Permalink
small typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
jstoiko committed Nov 10, 2015
1 parent 80cd8eb commit 1b7fca3
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
[![Build Status](https://travis-ci.org/brandicted/nefertari.svg?branch=master)](https://travis-ci.org/brandicted/nefertari)
[![Documentation](https://readthedocs.org/projects/nefertari/badge/?version=stable)](http://nefertari.readthedocs.org)

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).
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).
4 changes: 2 additions & 2 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Changelog
* :feature:`-` Event system is now crud-based as opposed to db-based
* :feature:`-` Refactored field processors to use the new event system
* :feature:`-` Removed unnecessary extra '__confirmation' parameter from PATCH/PUT/DELETE collection requests
* :feature:`-` Nested relationships are now indexed in bulk in ElasticSearch
* :feature:`-` Nested relationships are now indexed in bulk in Elasticsearch
* :feature:`-` Added '_hidden_fields' model attribute to hide fields while remaining editable (e.g. password)
* :bug:`- major` Fixed a bug causing polymorchic collections to always return 403
* :bug:`- major` Fixed nested relationships not respecting '_auth_fields'
Expand Down Expand Up @@ -64,7 +64,7 @@ Changelog

* :release:`0.3.0 <2015-05-18>`
* :support:`-` Step-by-step 'Getting started' guide
* :bug:`- major` Fixed several issues related to ElasticSearch indexing
* :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)
Expand Down
4 changes: 2 additions & 2 deletions docs/source/development_tools.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Development Tools
=================

Indexing in ElasticSearch
Indexing in Elasticsearch
-------------------------

``nefertari.index`` console script can be used to manually (re-)index models from your database engine to ElasticSearch.
``nefertari.index`` console script can be used to manually (re-)index models from your database engine to Elasticsearch.

You can run it like so::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Requirements
------------

* Python 2.7, 3.3 or 3.4
* Elasticsearch for ElasticSearch-powered resources (see :any:`models <models>` and :any:`requests <making_requests>`)
* Elasticsearch for Elasticsearch-powered resources (see :any:`models <models>` and :any:`requests <making_requests>`)
* Postgres or Mongodb


Expand Down
32 changes: 17 additions & 15 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
Nefertari, queen of APIs
========================

Source code: `<http://github.com/brandicted/nefertari>`_

Nefertari is a REST API framework for Pyramid that uses ElasticSearch for reads and either MongoDB or Postgres for writes.
Nefertari is a REST API framework for Pyramid that uses Elasticsearch for reads and either MongoDB or Postgres for writes.

Nefertari currently powers `Brandicted <https://brandicted.com>`_ and `Cerri <http://www.cerri.com>`_. She is fully production ready and actively maintained.

Source code:
`<http://github.com/brandicted/nefertari>`_


Table of Content
================

.. toctree::
:maxdepth: 2

getting_started
views
models
event_handlers
field_processors
auth
making_requests
development_tools
why
changelog
:maxdepth: 2

getting_started
views
models
event_handlers
field_processors
auth
making_requests
development_tools
why
changelog


.. image:: nefertari.jpg
Expand Down
10 changes: 5 additions & 5 deletions docs/source/making_requests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ url parameter description
=============================== ===========


Query syntax for ElasticSearch
Query syntax for Elasticsearch
------------------------------

Additional parameters are available when using an ElasticSearch-enabled collection (see **ESBaseDocument** in the :any:`Wrapper API <wrapper-api>` section of this documentation).
Additional parameters are available when using an Elasticsearch-enabled collection (see **ESBaseDocument** in the :any:`Wrapper API <wrapper-api>` section of this documentation).

======================================== ===========
url parameter description
Expand Down Expand Up @@ -94,6 +94,6 @@ Similarly, if delete_many() is defined, you will be able to delete entire collec
.. [#] Set ``enable_get_tunneling = true`` in your .ini file to enable this feature. To update listfields and dictfields, you can use the following syntax: ``_m=PATCH&<listfield>.<value>&<dictfield>.<key>=<value>``
.. [#] The full syntax of ElasticSearch querying is beyond the scope of this documentation. You can read more on the `ElasticSearch Query String Query documentation <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html>`_ to do things like fuzzy search: ``?name=fuzzy~`` or date range search: ``?date=[2015-01-01 TO *]``
.. [#] Set ``elasticsearch.enable_refresh_query = true`` in your .ini file to enable this feature. This parameter only works with POST, PATCH, PUT and DELETE methods. Read more on `ElasticSearch Bulk API documentation <https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html#bulk-refresh>`_.
.. [#] Set ``elasticsearch.enable_aggregations = true`` in your .ini file to enable this feature. You can also use the short name `_aggs`. Read more on `ElasticSearch Aggregations <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html>`_.
.. [#] The full syntax of Elasticsearch querying is beyond the scope of this documentation. You can read more on the `Elasticsearch Query String Query documentation <https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html>`_ to do things like fuzzy search: ``?name=fuzzy~`` or date range search: ``?date=[2015-01-01 TO *]``
.. [#] Set ``elasticsearch.enable_refresh_query = true`` in your .ini file to enable this feature. This parameter only works with POST, PATCH, PUT and DELETE methods. Read more on `Elasticsearch Bulk API documentation <https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html#bulk-refresh>`_.
.. [#] Set ``elasticsearch.enable_aggregations = true`` in your .ini file to enable this feature. You can also use the short name `_aggs`. Read more on `Elasticsearch Aggregations <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html>`_.
1 change: 1 addition & 0 deletions nefertari/authentication/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ def verify_password(user, password):

success = False
user = None
print params
login = params['login'].lower().strip()
key = 'email' if '@' in login else 'username'
try:
Expand Down
2 changes: 1 addition & 1 deletion nefertari/elasticsearch.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ def setup(cls, settings):
cls.api = elasticsearch.Elasticsearch(
hosts=hosts, serializer=engine.ESJSONSerializer(),
connection_class=ESHttpConnection, **params)
log.info('Including ElasticSearch. %s' % cls.settings)
log.info('Including Elasticsearch. %s' % cls.settings)

except KeyError as e:
raise Exception(
Expand Down
2 changes: 1 addition & 1 deletion nefertari/scaffolds/nefertari_starter/local.ini_tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ mongodb.host = localhost
mongodb.port = 27017
mongodb.db = {{package}}

#ElasticSearch
# Elasticsearch
elasticsearch.hosts = localhost:9200
elasticsearch.sniff = false
elasticsearch.index_name = {{package}}
Expand Down

0 comments on commit 1b7fca3

Please sign in to comment.