Lib for adding file upload functionality to GraphQL mutations in Graphene Django and Flask-Graphql
Project description
graphene-file-upload
graphene-file-upload is a drop in replacement for the the GraphQL view in Graphene for Django, and for Flask-Graphql. It supports multi-part file uploads that adhere to the Multipart Request Spec.
It currently supports Python 2.7 and 3.4+.
Installation:
pip install graphene-file-upload
Usage
To add an upload type to your mutation, import and use Upload. Upload is a scalar type.
from graphene_file_upload.scalars import Upload
class UploadMutation(graphene.Mutation):
class Arguments:
file = Upload(required=True)
success = graphene.Boolean()
def mutate(self, info, file, **kwargs):
# do something with your file
return UploadMutation(success=True)
Django Integration:
To use, import the view, then add to your list of urls (replace previous GraphQL view).
from graphene_file_upload.django import FileUploadGraphQLView
urlpatterns = [
url(r'^graphql', FileUploadGraphQLView.as_view(graphiql=True)),
]
Flask Integration:
Note that flask-graphql version <2.0 is not supported. At the time of writing this README, you must install flask-graphql with pip install --pre flask-graphql
Simply import the modified view and create a new url rule on your app:
from graphene_file_upload.flask import FileUploadGraphQLView
app.add_url_rule(
'/graphql',
view_func=FileUploadGraphQLView.as_view(
...
)
)
Contributing:
If you’d like to contribute, please run the test suite prior to sending a PR.
In order to run the testing environment, create a virtual environment, install tox, and run the tox commands:
python3 -m venv venv
source venv/bin/activate
pip install -r requirements-tox.txt
# You may have to deactivate and reactivate to have access to the tox command,
# depending on your system.
# Run the test suite with the versions of python you have installed
tox -e py27,py34
# Alternatively, if you're using something like pyenv and can easily install
# Multiple versions of python, then try running the following command
tox
# If for some reason you need to recreate the tox environment (e.g. a new
# dependency has been added since you last ran it, add the -r flag to the
# tox command)
tox -r {...additional flags...}
Check out pyenv if you’d like a simple way of installing multiple python versions to test out.
Packaging for PyPi:
Build the distribution.
python3 setup.py sdist bdist_wheel
Upload to PyPi test servers.
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Upload to PyPi production servers.
twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for graphene_file_upload-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de326a0f7677669d3cf389b4b443e3ca14b5fdf4c136392d076f3f6d57ddb7cb |
|
MD5 | 82dfda2eeb7f01313275ec8dca5f219b |
|
BLAKE2b-256 | 9e3c61575107a10bc8421ea726fa10a97efc439994792d33740fc88ddf72c853 |
Hashes for graphene_file_upload-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d41d4dbad980fd984c2b795f80bdc8ca91edea2c78722f1aeec4bfe6497cb067 |
|
MD5 | 922b546023fd24678446bce905571826 |
|
BLAKE2b-256 | 3b87f3d8ce7e4c8232829cd4e835c5abc15b136f109b02c67dd8fac477f45007 |