chore: contributing docs and tox config

Author: KingDarBoja

.coveragerc

@@ -0,0 +1,2 @@
+[report]
+omit = */tests/*

.travis.yml

@@ -1,5 +1,17 @@
 language: python
-sudo: false
+cache: pip
+dist: xenial
+
+install:
+  - pip install tox tox-travis
+
+script:
+  - tox
+
+after_success:
+  - pip install coveralls
+  - coveralls
+
 matrix:
   include:
   - python: pypy
@@ -12,16 +24,7 @@ matrix:
     env: TOX_ENV=py36
   - python: '3.6'
     env: TOX_ENV=import-order,flake8
-cache:
-  directories:
-  - $HOME/.cache/pip
-  - $TRAVIS_BUILD_DIR/.tox
-install:
-- pip install tox coveralls
-script:
-- tox -e $TOX_ENV -- --cov=flask_graphql
-after_success:
-- coveralls
+
 deploy:
   provider: pypi
   user: syrusakbary

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+Thanks for helping to make flask-graphql awesome!
+
+We welcome all kinds of contributions:
+
+- Bug fixes
+- Documentation improvements
+- New features
+- Refactoring & tidying
+
+
+## Getting started
+
+If you have a specific contribution in mind, be sure to check the [issues](https://github.com/graphql-python/flask-graphql/issues) and [projects](https://github.com/graphql-python/flask-graphql/projects) in progress - someone could already be working on something similar and you can help out.
+
+
+## Project setup
+
+After cloning this repo, ensure dependencies are installed by running:
+
+```sh
+make dev-setup
+```
+
+## Running tests
+
+After developing, the full test suite can be evaluated by running:
+
+```sh
+make tests
+```
+
+## Development on Conda
+
+In order to run `tox` command on conda, you must create a new env (e.g. `flask-grapqhl-dev`) with the following command:
+
+```sh
+conda create -n flask-grapqhl-dev python=3.8
+```
+
+Then activate the environment with `conda activate flask-grapqhl-dev` and install [tox-conda](https://github.com/tox-dev/tox-conda):
+
+```sh
+conda install -c conda-forge tox-conda
+```
+
+Uncomment the `requires = tox-conda` line on `tox.ini` file and that's it! Run `tox` and you will see all the environments being created and all passing tests. :rocket:
+

Makefile

@@ -0,0 +1,5 @@
+dev-setup:
+	python pip install -e ".[test]"
+
+tests:
+	py.test tests --cov=flask_graphql -vv

README.md

@@ -39,3 +39,6 @@ class UserRootValue(GraphQLView):
         return request.user
 
 ```
+
+## Contributing
+See [CONTRIBUTING.md](contributing.md)

flask_graphql/graphqlview.py

@@ -38,7 +38,7 @@ def __init__(self, **kwargs):
     def get_root_value(self):
         return self.root_value
 
-    def get_context(self):
+    def get_context_value(self):
         return request
 
     def get_middleware(self):
@@ -89,8 +89,8 @@ def dispatch_request(self):
                 backend=self.get_backend(),
 
                 # Execute options
-                root=self.get_root_value(),
-                context=self.get_context(),
+                root_value=self.get_root_value(),
+                context_value=self.get_context_value(),
                 middleware=self.get_middleware(),
                 **extra_options
             )

setup.py

@@ -1,12 +1,26 @@
 from setuptools import setup, find_packages
 
-required_packages = ["graphql-core>=2.1,<3", "flask>=0.7.0", "graphql-server-core>=1.1,<2"]
+install_requires = ["graphql-core>=2.1,<3", "flask>=0.7.0", "graphql-server-core>=1.1,<2"]
+
+tests_requires = [
+    'pytest >=2.7.2',
+    'pytest-flask >=0.10.0',
+    'graphql-core >=2.1,<3',
+    'graphql-server-core >=1.1,<2',
+    'Flask >=0.10.0',
+]
+
+dev_requires = [
+    'flake8==3.7.9',
+    'isort <4.0.0'
+] + tests_require
 
 setup(
     name="Flask-GraphQL",
     version="2.0.1",
     description="Adds GraphQL support to your Flask application",
-    long_description=open("README.rst").read(),
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
     url="https://github.com/graphql-python/flask-graphql",
     download_url="https://github.com/graphql-python/flask-graphql/releases",
     author="Syrus Akbary",
@@ -29,8 +43,12 @@
     ],
     keywords="api graphql protocol rest flask",
     packages=find_packages(exclude=["tests"]),
-    install_requires=required_packages,
-    tests_require=["pytest>=2.7.3"],
+    install_requires=install_requires,
+    tests_require=tests_requires,
+    extras_require={
+        'test': tests_require,
+        'dev': dev_requires,
+    }
     include_package_data=True,
     zip_safe=False,
     platforms="any",

tests/test_graphiqlview.py

@@ -6,34 +6,49 @@
 
 @pytest.fixture
 def app():
-    return create_app(graphiql=True)
+    # import app factory pattern
+    app = create_app(graphiql=True)
 
+    # pushes an application context manually
+    ctx = app.app_context()
+    ctx.push()
+    return app
 
-def test_graphiql_is_enabled(client):
-    response = client.get(url_for('graphql'), headers={'Accept': 'text/html'})
+
+@pytest.fixture
+def client(app):
+    return app.test_client()
+
+
+def test_graphiql_is_enabled(app, client):
+    with app.test_request_context():
+        response = client.get(url_for('graphql', externals=False), headers={'Accept': 'text/html'})
     assert response.status_code == 200
 
 
-def test_graphiql_renders_pretty(client):
-    response = client.get(url_for('graphql', query='{test}'), headers={'Accept': 'text/html'})
+def test_graphiql_renders_pretty(app, client):
+    with app.test_request_context():
+        response = client.get(url_for('graphql', query='{test}'), headers={'Accept': 'text/html'})
     assert response.status_code == 200
     pretty_response = (
         '{\n'
         '  "data": {\n'
         '    "test": "Hello World"\n'
         '  }\n'
         '}'
-    ).replace("\"","\\\"").replace("\n","\\n")
+    ).replace("\"", "\\\"").replace("\n", "\\n")
 
     assert pretty_response in response.data.decode('utf-8')
 
 
-def test_graphiql_default_title(client):
-    response = client.get(url_for('graphql'), headers={'Accept': 'text/html'})
+def test_graphiql_default_title(app, client):
+    with app.test_request_context():
+        response = client.get(url_for('graphql'), headers={'Accept': 'text/html'})
     assert '<title>GraphiQL</title>' in response.data.decode('utf-8')
 
 
 @pytest.mark.parametrize('app', [create_app(graphiql=True, graphiql_html_title="Awesome")])
-def test_graphiql_custom_title(client):
-    response = client.get(url_for('graphql'), headers={'Accept': 'text/html'})
+def test_graphiql_custom_title(app, client):
+    with app.test_request_context():
+        response = client.get(url_for('graphql'), headers={'Accept': 'text/html'})
     assert '<title>Awesome</title>' in response.data.decode('utf-8')