Hello 0.3.0 version!

sacrud · Jan 7, 2016 · 90052dc · 90052dc
2 parents 4652c96 + 339be0d
commit 90052dc
Show file tree

Hide file tree

Showing 118 changed files with 21,443 additions and 3,186 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -20,49 +20,26 @@ notifications:
     on_failure: always
 
 python:
+  - "2.7"
   - "3.3"
   - "3.4"
   - "3.5"
-
-matrix:
-  include:
-    - python: "2.7"
-      env: LINK_CHECK=1
-    - python: "pypy"
-      env: NO_BDD=1
-    - python: "pypy3"
-      env: NO_RSTLINT=1 NO_BDD=1
-
-before_install:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
+  - "pypy"
 
 install:
-
-  # Python
-  - python setup.py develop
-  - pip install -r example/requirements.txt
-
-  - if [ -n "$LINK_CHECK" ];then pip install linkchecker; fi
   - pip install flake8 rstcheck
-  - pip install behave selenium waitress
+  - pip install -r requirements.txt
+  - pip install -r requirements-test.txt
+  - pip install -r requirements-docs.txt
+  - pip install .
 
 script:
-  # Nosetests
-  - python setup.py nosetests
+  # Pytest
+  - py.test --cov=pyramid_sacrud --doctest-modules  tests/ pyramid_sacrud/
 
   # Styles check
   - if [ -z "$NO_RSTLINT" ]; then ./test.sh; fi
 
-  # BDD
-  - cd example
-  - python pyramid_sacrud_example.py&
-  - cd ..
-  - if [ -z "$NO_BDD" ];then behave --no-capture; fi
-
-  # Link checker
-  - if [ -n "$LINK_CHECK" ];then linkchecker http://localhost:6543/admin/ --ignore-url="unquote\(%*" --no-status; fi
-
 after_success:
   - pip install coveralls
   - coveralls
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,11 +1,6 @@
-0.2.1 (2015-12-02)
+0.3.0 (2016-01-??)
 ==================
 
-- set empty footer block in base template #109
-- fix empty nullable integer columns break #107
-
-0.2.0 (2015-11-13)
-==================
-
-- new materialize-css design
-- webpack.js for build css and js
+- New resources architecture
+- move SQLAlchemy handler to separate module ``ps_alchemy``
+- migrate test to py.test (#102 issue)
diff --git a/CHANGES_OLD.rst b/CHANGES_OLD.rst
@@ -1,3 +1,15 @@
+0.2.1 (2015-12-02)
+==================
+
+- set empty footer block in base template #109
+- fix empty nullable integer columns break #107
+
+0.2.0 (2015-11-13)
+==================
+
+- new materialize-css design
+- webpack.js for build css and js
+
 0.1.3 (2015-09-08)
 ==================
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,12 +1,11 @@
-recursive-include pyramid_sacrud/templates *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.jinja2 *.js *.html *.xml
-recursive-include pyramid_sacrud/static/css *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.jinja2 *.js *.html *.xml
-recursive-include pyramid_sacrud/static/fonts *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.jinja2 *.js *.html *.xml *.eot *.svg *.ttf *.woff *.woff2
-recursive-include pyramid_sacrud/static/img *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.jinja2 *.js *.html *.xml
+recursive-include pyramid_sacrud/templates *.jinja2
+recursive-include pyramid_sacrud/static/css *
+recursive-include pyramid_sacrud/static/fonts *
+recursive-include pyramid_sacrud/static/img *
 recursive-include pyramid_sacrud/static/js *.js
 recursive-include pyramid_sacrud/locale *
 include requirements.txt
 include requirements-test.txt
 include README.rst
 include CHANGES.rst
 include message-extraction.ini
-include pyramid_sacrud/static/js/main.js
diff --git a/README.rst b/README.rst
@@ -1,4 +1,4 @@
-|Build Status| |Coverage Status| |Stories in Progress| |PyPI|
+|Build Status| |Coverage Status| |PyPI|
 
 pyramid_sacrud
 ==============
@@ -8,16 +8,28 @@ Documentation `<http://pyramid-sacrud.readthedocs.org/en/latest/>`_
 Overview
 --------
 
-Pyramid CRUD interface based on sacrud_ and SQLAlchemy.
-Provides an administration web interface for Pyramid.
+Pyramid CRUD interface. Provides an administration web interface for Pyramid.
 Unlike classic CRUD, ``pyramid_sacrud`` allows overrides and flexibility to
-customize your interface, similar to ``django.contrib.admin``.
+customize your interface, similar to ``django.contrib.admin`` but uses a
+different backend to provide resources. :ref:`architecture` built on the
+resources and mechanism traversal, allows to use it in various cases.
 
-Look how easy it is to use with Pyramid:
+The list of standard backends:
+
+* `ps_alchemy <http://github.com/sacrud/ps_alchemy>`_ - provides SQLAlchemy
+  models.
+* ps_mongo - provides MongoDB.
+* etc..
+
+Look how easy it is to use with Pyramid and SQLAlchemy:
 
 .. code-block:: python
 
     from .models import (Model1, Model2, Model3,)
+
+    # add SQLAlchemy backend
+    config.include('ps_alchemy')
+
     # add sacrud and project models
     config.include('pyramid_sacrud')
     settings = config.registry.settings
@@ -26,51 +38,24 @@ Look how easy it is to use with Pyramid:
 
 go to http://localhost:6543/sacrud/
 
-Example can be found here https://github.com/ITCase/pyramid_sacrud/tree/master/example
-
 And see...
 
 |sacrud_index|
 
+Example can be found here https://github.com/sacrud/ps_alchemy/tree/master/example
+
 Installing
 ==========
 
-GitHub
-------
-
-.. code-block:: bash
-
-    pip install git+http://github.com/ITCase/pyramid_sacrud.git
-
-PyPi
-----
-
 .. code-block:: bash
 
     pip install pyramid_sacrud
 
-Source
-------
-
-.. code-block:: bash
-
-    git clone git+http://github.com/ITCase/pyramid_sacrud.git
-    python setup.py install
-
-Contribute
-----------
-
-.. code-block:: bash
-
-    git clone git+http://github.com/ITCase/pyramid_sacrud.git
-    python setup.py develop
-
 Support and Development
 =======================
 
 To report bugs, use the `issue tracker
-<https://github.com/ITCase/pyramid_sacrud/issues>`_ or `waffle board
-<https://waffle.io/ITCase/pyramid_sacrud>`_.
+<https://github.com/sacrud/pyramid_sacrud/issues>`_.
 
 We welcome any contribution: suggestions, ideas, commits with new futures,
 bug fixes, refactoring, docs, tests, translations etc
@@ -82,20 +67,11 @@ License
 
 The project is licensed under the MIT license.
 
-.. |Build Status| image:: https://travis-ci.org/ITCase/pyramid_sacrud.svg?branch=master
-   :target: https://travis-ci.org/ITCase/pyramid_sacrud
-.. |Coverage Status| image:: https://coveralls.io/repos/ITCase/pyramid_sacrud/badge.png?branch=master
-   :target: https://coveralls.io/r/ITCase/pyramid_sacrud?branch=master
-.. |sacrud_index| image:: https://raw.githubusercontent.com/ITCase/pyramid_sacrud/master/docs/_static/img/index.png
-   :target: https://raw.githubusercontent.com/ITCase/pyramid_sacrud/master/docs/_static/img/index.png
-.. |Stories in Progress| image:: https://badge.waffle.io/ITCase/pyramid_sacrud.png?label=in%20progress&title=In%20Progress
-   :target: http://waffle.io/ITCase/pyramid_sacrud
+.. |Build Status| image:: https://travis-ci.org/sacrud/pyramid_sacrud.svg?branch=master
+   :target: https://travis-ci.org/sacrud/pyramid_sacrud
+.. |Coverage Status| image:: https://coveralls.io/repos/sacrud/pyramid_sacrud/badge.png?branch=master
+   :target: https://coveralls.io/r/sacrud/pyramid_sacrud?branch=master
+.. |sacrud_index| image:: https://raw.githubusercontent.com/sacrud/pyramid_sacrud/master/docs/_static/img/index.png
+   :target: https://raw.githubusercontent.com/sacrud/pyramid_sacrud/master/docs/_static/img/index.png
 .. |PyPI| image:: http://img.shields.io/pypi/dm/pyramid_sacrud.svg
    :target: https://pypi.python.org/pypi/pyramid_sacrud/
-
-.. _sacrud: https://github.com/ITCase/sacrud/
-
-
-.. image:: https://badges.gitter.im/Join%20Chat.svg
-   :alt: Join the chat at https://gitter.im/ITCase/pyramid_sacrud
-   :target: https://gitter.im/ITCase/pyramid_sacrud?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
diff --git a/behave.ini b/behave.ini
diff --git a/docs/_static/img/ManyToManyField.png b/docs/_static/img/ManyToManyField.png
diff --git a/docs/_static/img/column_css.png b/docs/_static/img/column_css.png
diff --git a/docs/_static/img/column_description.png b/docs/_static/img/column_description.png
diff --git a/docs/_static/img/column_verbose_name.png b/docs/_static/img/column_verbose_name.png
diff --git a/docs/_static/img/dashboard.png b/docs/_static/img/dashboard.png
diff --git a/docs/_static/img/index.png b/docs/_static/img/index.png
diff --git a/docs/_static/img/internationalization_de.png b/docs/_static/img/internationalization_de.png
diff --git a/docs/_static/img/internationalization_en.png b/docs/_static/img/internationalization_en.png
diff --git a/docs/_static/img/internationalization_ru.png b/docs/_static/img/internationalization_ru.png
diff --git a/docs/_static/img/locale_form_en.png b/docs/_static/img/locale_form_en.png
diff --git a/docs/_static/img/locale_form_ru.png b/docs/_static/img/locale_form_ru.png
diff --git a/docs/_static/img/locale_model_en.png b/docs/_static/img/locale_model_en.png
diff --git a/docs/_static/img/locale_model_ru.png b/docs/_static/img/locale_model_ru.png
diff --git a/docs/_static/img/sacrud_detail_col.png b/docs/_static/img/sacrud_detail_col.png
diff --git a/docs/_static/img/sacrud_list_col.png b/docs/_static/img/sacrud_list_col.png
diff --git a/docs/_static/img/verbose_name.png b/docs/_static/img/verbose_name.png
diff --git a/docs/_static/img/widget_row_lambda.png b/docs/_static/img/widget_row_lambda.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,14 +8,9 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode'
 ]
 
-intersphinx_mapping = {
-    'http://sacrud.readthedocs.org/en/master': None,
-}
-
 # The suffix of source filenames.
 source_suffix = '.rst'
 
@@ -33,7 +28,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '_static/pencil/*']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -61,6 +56,6 @@
 html_theme_options = {
     'travis_button': True,
     'github_button': True,
-    'github_user': 'ITCase',
+    'github_user': 'sacrud',
     'github_repo': 'pyramid_sacrud',
 }
diff --git a/docs/includes/include_contribute.rst b/docs/includes/include_contribute.rst
diff --git a/docs/includes/include_license.rst b/docs/includes/include_license.rst
diff --git a/docs/includes/include_overview.rst b/docs/includes/include_overview.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,7 +11,41 @@ Overview
    :alt: SACRUD main page
    :align: right
 
-.. include:: includes/include_overview.rst
+Pyramid CRUD interface. Provides an administration web interface for Pyramid.
+Unlike classic CRUD, ``pyramid_sacrud`` allows overrides and flexibility to
+customize your interface, similar to ``django.contrib.admin`` but uses a
+different backend to provide resources. :ref:`architecture` built on the
+resources and mechanism traversal, allows to use it in various cases.
+
+The list of standard backends:
+
+* `ps_alchemy <http://github.com/sacrud/ps_alchemy>`_ - provides SQLAlchemy
+  models.
+* ps_mongo - provides MongoDB.
+* etc..
+
+.. raw:: html
+
+   <br clear="both"/>
+
+Look how easy it is to use with Pyramid and SQLAlchemy:
+
+.. code-block:: python
+
+    from .models import (Model1, Model2, Model3,)
+
+    # add SQLAlchemy backend
+    config.include('ps_alchemy')
+
+    # add sacrud and project models
+    config.include('pyramid_sacrud')
+    settings = config.registry.settings
+    settings['pyramid_sacrud.models'] = (('Group1', [Model1, Model2]),
+                                         ('Group2', [Model3]))
+
+go to http://localhost:6543/sacrud/
+
+Example can be found here https://github.com/sacrud/ps_alchemy/tree/master/example
 
 Usage
 =====
@@ -21,8 +55,8 @@ Usage
 
   pages/install
   pages/configuration
-  pages/localization
   pages/permissions
+  pages/examples
   pages/api
 
 Contribute
@@ -33,8 +67,21 @@ Contribute
 
   pages/contribute/index.rst
 
-.. include:: includes/include_contribute.rst
-.. include:: includes/include_license.rst
+Support and Development
+=======================
+
+To report bugs, use the `issue tracker
+<https://github.com/sacrud/pyramid_sacrud/issues>`_.
+
+We welcome any contribution: suggestions, ideas, commits with new futures,
+bug fixes, refactoring, docs, tests, translations etc
+
+If you have question, contact me sacrud@uralbash.ru or IRC channel #sacrud
+
+License
+=======
+
+The project is licensed under the MIT license.
 
 Indices and tables
 ==================