Skip to content

Commit

Permalink
Documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Preetwinder committed Aug 17, 2016
1 parent 0be3855 commit 8a63703
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/topics/installation.rst
Expand Up @@ -4,7 +4,7 @@ Installation Guide

The installation steps assume that you have the following requirements installed:

* `Python`_ 2.7
* `Python`_ 2.7+ or 3.4+

* `pip`_ and `setuptools`_ Python packages. Nowadays `pip`_ requires and
installs `setuptools`_ if not installed.
Expand Down
1 change: 1 addition & 0 deletions docs/source/topics/overview.rst
Expand Up @@ -16,6 +16,7 @@ downloading them from the web. Main features of Frontera are:
:doc:`Graph Manager <graph-manager>`.
* transparent transport layer concept (:term:`message bus`) and communication protocol,
* pure Python implementation.
* Python 3 support.


.. _use-cases:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/topics/quick-start-distributed.rst
Expand Up @@ -13,7 +13,7 @@ Prerequisites

Here is what services needs to be installed and configured before running Frontera:

- Python 2.7+
- Python 2.7+ or 3.4+
- Scrapy

Frontera installation
Expand Down
2 changes: 1 addition & 1 deletion frontera/contrib/middlewares/domain.py
Expand Up @@ -15,7 +15,7 @@ class DomainMiddleware(Middleware):
:attr:`Response.meta <frontera.core.models.Response.meta>` if is activated.
``domain`` object will contains the following fields:
``domain`` object will contains the following fields, with both keys and values as bytes:
- **netloc**: URL netloc according to `RFC 1808`_ syntax specifications
- **name**: Domain name
Expand Down
2 changes: 2 additions & 0 deletions frontera/contrib/middlewares/fingerprint.py
Expand Up @@ -54,6 +54,7 @@ class UrlFingerprintMiddleware(BaseFingerprintMiddleware):
Fingerprint will be calculated from object ``URL``, using the function defined in
:setting:`URL_FINGERPRINT_FUNCTION` setting.
You can write your own fingerprint calculation function and use by changing this setting.
The fingerprint must be bytes.
An example for a :class:`Request <frontera.core.models.Request>` object::
Expand Down Expand Up @@ -87,6 +88,7 @@ class DomainFingerprintMiddleware(BaseFingerprintMiddleware):
Fingerprint will be calculated from object ``URL``, using the function defined in
:setting:`DOMAIN_FINGERPRINT_FUNCTION` setting.
You can write your own fingerprint calculation function and use by changing this setting.
The fingerprint must be bytes
An example for a :class:`Request <frontera.core.models.Request>` object::
Expand Down
4 changes: 2 additions & 2 deletions frontera/core/models.py
Expand Up @@ -22,7 +22,7 @@ def __init__(self, url, method=b'GET', headers=None, cookies=None, meta=None, bo
:param string method: HTTP method to use.
:param dict headers: dictionary of headers to send.
:param dict cookies: dictionary of cookies to attach to this request.
:param dict meta: dictionary that contains arbitrary metadata for this request.
:param dict meta: dictionary that contains arbitrary metadata for this request, both keys and values should be bytes.
"""
self._url = to_native_str(url)
self._method = to_bytes((method or b'GET').upper())
Expand Down Expand Up @@ -65,7 +65,7 @@ def meta(self):
"""
A dict that contains arbitrary metadata for this request. This dict is empty for new Requests, and is usually
populated by different Frontera components (middlewares, etc). So the data contained in this dict depends
on the components you have enabled.
on the components you have enabled. Both the keys and values in the dictionary are bytes.
"""
return self._meta

Expand Down

0 comments on commit 8a63703

Please sign in to comment.