Skip to content

Commit

Permalink
Merge branch 'release/0.1.4'
Browse files Browse the repository at this point in the history
  • Loading branch information
jose ariza committed Sep 6, 2016
2 parents 69ae920 + b3daed7 commit 469a904
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
@@ -1,4 +1,4 @@
* Django Wordpres API version:
* Django Wordpress API version:
* Django version:
* Python version:
* Operating System:
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Expand Up @@ -36,8 +36,8 @@ is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

Django Wordpres API could always use more documentation, whether as part of the
official Django Wordpres API docs, in docstrings, or even on the web in blog posts,
Django Wordpress API could always use more documentation, whether as part of the
official Django Wordpress API docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
Expand Down
8 changes: 5 additions & 3 deletions README.rst
@@ -1,5 +1,5 @@
=============================
Django Wordpres API
Django Wordpress API
=============================

.. image:: https://badge.fury.io/py/django-wordpress-api.png
Expand All @@ -17,7 +17,9 @@ Django Wordpres API

Easily Install your Wordpress blog in your Django project

This package allows to communicate easily with any wordpress proyect that is using [WP REST API v1](http://wp-api.org/index-deprecated.html). Even though the WP REST API package is already on the 2 version; it is still on beta so it was decided that this package will only support v1 until v2 is out of beta.
This package allows to communicate easily with any wordpress proyect that is using `WP REST API v1 <http://wp-api.org/index-deprecated.html>`_ .

Even though the WP REST API package is already on the 2 version; it is still on beta so it was decided that this package will only support v1 until v2 is out of beta.

Documentation
-------------
Expand All @@ -40,7 +42,7 @@ Features

* Connect to an external wordpress application
* Retreives all the blog posts ordered by pages
* Filter blog posts using several of the [available filters in WP REST API](http://wp-api.org/index-deprecated.html#posts_retrieve-posts)
* Filter blog posts using several of the `available filters in WP REST API <http://wp-api.org/index-deprecated.html#posts_retrieve-posts>`_
* Search blog posts using a keyword
* order the blog posts by several attributes like author, title, type, etc; ascending and descending order (default order is descending date)
* Retreive posts with a different type than "post"
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Django Wordpres API's documentation!
Welcome to Django Wordpress API's documentation!
=================================================================

Contents:
Expand Down
2 changes: 1 addition & 1 deletion docs/integration.rst
Expand Up @@ -19,7 +19,7 @@ You need two settings variables to be able to use the package:
WP_URL = http://your-wordpress-app.com/
BLOG_POSTS_PER_PAGE = <number-of-blogs-to-display-per-page>

Remmember to add [WP REST API v1](http://wp-api.org/index-deprecated.html) to http://your-wordpress-app.com/ or this package will be useless.
Remmember to add `WP REST API v1 <http://wp-api.org/index-deprecated.html>`_ to http://your-wordpress-app.com/ or this package will be useless.


Add django-wordpress-api
Expand Down
9 changes: 5 additions & 4 deletions docs/usage.rst
Expand Up @@ -2,22 +2,23 @@
Usage
========

To use Django Wordpres API in a project::
To use Django Wordpress API in a project::

import wordpress_api

The django-wordpress-api has two main features:

the WPApiConnector and the Views that uses it.

If you want to use the pre defined views, just add wordpress-api-urls to your project.


The basic django-wordpress-api urls are::

::
http://localhost:8000/blog/; display the blog list

http://localhost:8000/(?P<slug>[-\w]+)/; displays the detail of a blog identified with the given slug

http://localhost:8000/category/(?P<slug>[-\w]+)/; displays the blogs in the category identified with the given slug

http://localhost:8000/tag/(?P<slug>[-\w]+)/; displays the blogs in the tag identified with the given slug

Else, If you want to retreive the blog posts in your custom views, you can use directly the WPApiConnector and its methods. You can check them at wordpress_api/utils.py
2 changes: 1 addition & 1 deletion example/templates/wordpress_api/base.html
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>{% block title %}Django Wordpres API{% endblock title %}</title>
<title>{% block title %}Django Wordpress API{% endblock title %}</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -8,7 +8,7 @@
except ImportError:
from distutils.core import setup

version = '0.1.3'
version = '0.1.4'

if sys.argv[-1] == 'publish':
try:
Expand Down

0 comments on commit 469a904

Please sign in to comment.