This example project demonstrates the pyuploadcare capabilities. The project is based on Python 3.8 and Django 3.2.8.
To install the example application you need to install Docker Compose package.
When Docker Compose is installed, clone this repository and build a Docker image by using the build directive:
$ git clone [email protected]:uploadcare/pyuploadcare-example.git
$ docker-compose buildThis command will build an image for the application.
Also you need to prepare secret.env file with your public and secret keys
as environmental variables for docker container to use
# 1. Copy example into your local `secret.env`
cp secret.env.example secret.env
# 2. Fill the values with your favourite editorWhen the image is ready — up the containers with the following command.
Migrations are applied on each container startup (look at ./app/start.sh).
$ docker-compose up -dNow, the application must be available in your web-browser, on http://localhost:8000
First of all, clone this repository:
$ git clone [email protected]:uploadcare/pyuploadcare-example.gitMake sure Python and Poetry are installed on your system. Fire command prompt and run command:
$ python -V
Python 3.8.9
$ poetry --version
Poetry version 1.1.9If Python or Poetry are not installed, check out following links with instructions, how to install those:
Then install dependencies:
$ poetry installAfter dependencies are installed, apply database migrations:
$ poetry run python app/manage.py migrateNow, you can run the server:
$ poetry run python app/manage.py runserverand see the application available in your web-browser, on http://localhost:8000
To start using tha application you need to set your API keys (public key and secret key).
These keys can be set as ENV variables using the export directive:
$ export UPLOADCARE_PUBLIC_KEY=demopublickey
$ export UPLOADCARE_SECRET_KEY=demoprivatekeyYou can get the project information by your public key.
This section contains operations with files. Such as uploading, copying, storing, deleting and creating file groups.
The page shows all the files you have on Uploadcare servers. Each file has actions, so it is possible to manage files on this page as well as on the show page.
To go to the show page, simply click on a filename.
There are blocks with readonly appdata and editable metadata:
The index page also supports batch operations pages — batch store, batch delete, create file group from selected files.
Just select multiple files and apply batch action.
File Groups section provides user interface to manage file groups on Uploadcare.
The index page shows a minimal info about each group including ID and files count.
There is also a button for deleting the group
Click on a group ID, you go to the show group page:
To upload file, click on Upload button in files index page. Then click Choose file on the form to upload local file or input file's URL.
The application can manage documents and video conversions sending request to Uploadcare REST API Conversion endpoints.
NOTE
Remember, to convert files, your account must have this feature enabled. It means that your UPLOADCARE_PUBLIC_KEY and UPLOADCARE_SECRET_KEY (not demo keys) must be specified in environment variables. This feature is only available for paid plans.
To convert a document, go to the Convert document section, choose a file to convert, target format and page (if the chosen target format is jpg or png and you want to convert a single page of a multi-paged document). There is a Store checkbox responsible for storing files as mentioned above.
After the form is submitted, you'll see a Conversion result page, which shows some info about conversion: Status, Error and link to the output file.
Updating the page will refresh the status.
Video conversion works the same way but the form has some additional parameters to set.
Conversion result page also includes information about how conversion is going.
User can execute operations that wrapped as addons. There are three implemented addons:
- background removing
- virus scanning
- object recognition
For additional information proceed to Uploadcare REST API Add-ons.
You only need to choose a file to start a recognition
After all corresponding part of file's adddata is rendered
and you can get into full file information if needed
Choose a file to scan and additional action for revealed infected file
Application renders corresponding part of file's adddata and the link to full file info page
Background removing has a bunch of options to select.
Usually it takes time to remove the background especially for large images,
so you may see IN_PROGRESS status page with refresh button
Image with removed background will be put into new file, so the result page has both links to the original file and created one
The webhooks section represents CRUD(create, read, update, delete) operations for Uploadcare webhooks.
NOTE
Remember, to manage webhooks, your account must have this feature enabled. It means that your UPLOADCARE_PUBLIC_KEY and UPLOADCARE_SECRET_KEY (not demo keys) must be specified in environment variables. This feature is only available for paid plans.
The menu button Webhooks points to the webhooks list page. Each list item has edit/delete actions and minimal info about a webhook.
Clicking on an ID of a list item redirects you to the show page of a webhook. Here you can find additional info and actions.
To create a new webhook, click the Create a webhook button in the menu. On the form, you should specify an URL for your webhook and check if it should be enabled immediately.
This section of the application made to demonstrate view helpers that allow to place Uploadcare File Uploader widget to a Django template.
The app has a model called Post and having fields title, content, logo and attachments. Logo and attachments represent uploadcare.File and uploadcare.FileGroup respectively.
Index page for posts shows a list of posts. Each list item has edit/delete actions.
Clicking on title will direct you to the show page of a post.
To create a new post, click on the Add button in posts index page. The post form will be opened. The form contains a text fields for post title and content, one File Uploader — for post's logo and one — for post's attachments. These File Uploaders differ from each other by the multiple option. For logo it is false, and for attachments — true.
