Skip to content

Integration between WTForms and Uploadcare service

License

Notifications You must be signed in to change notification settings

uploadcare/pyuploadcare-wtforms

Repository files navigation

Pyuploadcare-wtforms

Latest PyPI version Build status

Installation

$ pip install pyuploadcare-wtforms

Usage

Package provides several fields for WTForms which made integration with Uploadcare little more easily:

  • FileWidget
  • FileField
  • ImageField - you can set manual cropping for uploaded images
  • FileGroupField

In common case for usage you need:

  • Use one of these fields in your form like this:
# your_app/forms.py

from wtforms import Form
from pyuploadcare_wtforms import ImageField

class YourSuperForm(Form):
    image = ImageField(manual_crop='200x200')
    ...
  • Set up keys:
# your_project_config.py
from pyuploadcare import conf

conf.pub_key = 'demopublickey'
conf.secret = 'demoprivatekey'
<script src="https://ucarecdn.com/widget/2.5.5/uploadcare/uploadcare.full.min.js" charset="utf-8"></script>

Look at that simplest example for getting quick start. You can easily install it locally by:

$ make run_example

Contributing

Thanks to those who have already contributed,

Below we explain how to contribute efficiently.

  1. Fork the pyuploadcare-wtforms repo on GitHub.
  2. Clone your fork locally:
$ git clone git@github.com:your_name_here/pyuploadcare-wtforms.git
  1. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv pyuploadcare-wtforms
$ cd pyuploadcare-wtforms/
$ python setup.py develop
  1. Create a branch for local development:
 $ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.
  1. When you're done making changes, check that your changes pass the tests, including testing other Python versions with tox:
$ pip install tox
$ tox
  1. Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Security issues

If you think you ran into something in Uploadcare libraries which might have security implications, please hit us up at bugbounty@uploadcare.com or Hackerone.

We'll contact you personally in a short time to fix an issue through co-op and prior to any public disclosure.