Skip to content

Commit

Permalink
Bumped version, translated README.md to English.
Browse files Browse the repository at this point in the history
  • Loading branch information
themayarose committed Nov 7, 2016
1 parent 75ec508 commit 9e6216b
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 54 deletions.
114 changes: 61 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,65 @@

# Anubis

## Extensão para Django especializada em pesquisa em banco de dados.

**Anubis** é uma extensão para Django que visa facilitar o trabalho com bancos
de dados voltados primariamente para pesquisa - ou seja, bancos em que a
pesquisa de registros é mais frequente e importante do que a inserção e/ou
alteração de registros.

### Recursos

* Front-end de pesquisa em [React.js](https://facebook.github.io/react/)
automatizado e de fácil implementação. Você escreve seu modelo, inclui os
*mixins* do front-end e tem uma interface de pesquisa instantânea, com suporte
a pesquis*mixins*as com lógica booleana.
* Definição de
[Functions](https://www.postgresql.org/docs/current/static/sql-createfunction.html)
do [PostgreSQL](https://www.postgresql.org/) diretamente nas migrações do
projeto Django, permitindo gerenciá-las diretamente do código do projeto em
Python.
* Definição simplificada de unidades de pesquisa baseadas em QuerySets,
pesquisas por texto completo e Functions, sem necessidade de programá-las
diretamente (mas com flexibilidade o suficiente quando necessário).
* Facilidades de integração com
[ElasticSearch](https://www.elastic.co/products/elasticsearch) para quando
pesquisas baseadas em texto completo do
[PostgreSQL](https://www.postgresql.org/docs/current/static/textsearch.html) não
forem suficientes.

### Requerimentos

* [PostgreSQL](https://www.postgresql.org/download/) 9.3+, com a extensão
[unaccent](https://www.postgresql.org/docs/current/static/unaccent.html)
instalada.
## User-friendly database querying tool for Django-based apps

**Anubis** is a [Django](https://www.djangoproject.com) extension created with
the purpose of easing the work of binding databases to user-friendly interfaces,
without giving up the ability to access advanced features from said databases.
It's intended primarily for high-read, low-write databases - i.e., databases in
which accessing information is more important and frequent than updating it.

### Features

* [React.js](https://facebook.github.io/react/)-based built-in search front-end
that comes with boolean logic compositing for free. You just write your Django
models, then when you write your views, you inherit from the provided
front-end *mixins*, and **Anubis** will generate a fully-featured search
interface automatically.

* [PostgreSQL](https://www.postgresql.org/)'s
[Functions](https://www.postgresql.org/docs/current/static/sql-createfunction.html)
built-in support, allowing you to define and modify functions directly in your
Django project, streamlined with Django's migration framework workflow.

* Allows you to easily define basic search units for your database, based either
in Django's QuerySets, PostgreSQL's [full-text
search](https://www.postgresql.org/docs/current/static/textsearch-intro.html)
functionality or Functions. There is no need to write code for getting this
feature, although it's flexible enough for it to possible when needed.

* Simple integration with
[Elasticsearch](https://www.elastic.co/products/elasticsearch)-based full text
search for when PostgreSQL's is not enough.

### Requirements

* [PostgreSQL](https://www.postgresql.org/download/) 9.3+, with the
[unaccent](https://www.postgresql.org/docs/current/static/unaccent.html)
extension installed.

* [Stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) 1.2+
(para biblioteca de interpretação de pesquisas booleanas).
* [Node.js](https://nodejs.org/en/download/) com [npm]() para geração da
interface de pesquisa. Se, durante a instalação, um executável do
[yarn](https://code.facebook.com/posts/1840075619545360) for encontrado, ele
será utilizado (a velocidade de instalação de pacotes com o yarn é muito
superior à do npm atualmente).
* [Python](https://www.python.org/downloads/) 3.4+ para a aplicação Web.
* Um servidor WSGI (como
[uWSGI](http://uwsgi-docs.readthedocs.io/en/latest/WSGIquickstart.html) ou
[Gunicorn](http://gunicorn.org/)) e, para o caso de uma aplicação pública, é
altamente recomendável rodá-lo atrás de um servidor robusto como
[nginx](http://nginx.org/en/download.html) ou
[Apache](https://httpd.apache.org/download.cgi). Note que, no atual estágio de
desenvolvimento, **não é recomndável utilizar o Anubis em aplicações públicas
na Internet**.
* Uma distribuição do [Linux](https://distrowatch.com/dwres.php?resource=major).
Utilizar o Anubis em um servidor Windows pode ser possível (especialmente com o
advento do [Bash para
Windows](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)), mas
**a utilização em servidores Windows não é suportada nem testada pelos
desenvolvedores do Anubis**.
(for the boolean-logic library).

* [Node.js](https://nodejs.org/en/download/) with [npm](https://www.npmjs.com/)
installed for building the search interface. If a
[yarn](https://code.facebook.com/posts/1840075619545360) executable is found
during installation, it will be used instead (yarn's speed is currently vastly
superior to npm's.)

* [Python](https://www.python.org/downloads/) 3.4+ for the web application.

* A WSGI server (such as
[uWSGI](http://uwsgi-docs.readthedocs.io/en/latest/WSGIquickstart.html) or
[Gunicorn](http://gunicorn.org/)), and, if you have a public-facing app, it's
highly recommended running it behind a more robust server such as
[nginx](http://nginx.org/en/download.html) or
[Apache](https://httpd.apache.org/download.cgi). Please note that currently
**it is not advisable to run Anubis in Internet-facing environments**.

* A [Linux](https://distrowatch.com/dwres.php?resource=major) distribution. It
may be possible to run Anubis under a Windows server (specially since the
release of [Bash for
Windows](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)), but
**using Anubis in Windows-based environments is not currently supported or
tested by the Anubis development team**.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ class DevelopAnubis(CompileFrontendMixin, CompileHaskellMixin, develop):

setup(
name="anubis",
version="1.0a6",
version="1.0a7",
packages=[
"anubis",
"anubis.app",
Expand Down

0 comments on commit 9e6216b

Please sign in to comment.