1
1
Blender Extensions platform
Go to file
Pablo Vazquez 5612f62722 UI: Slightly smaller permission heading
It was a bit too large for a list that can become dense when the
extension has many permissions set.
2024-05-17 11:52:05 +02:00
abuse Abuse Reports: Update statuses 2024-05-06 16:29:55 +02:00
access Initial models, tests and other boilerplate 2022-08-25 17:37:48 +02:00
assets_shared@ffcc72b5cb Chore: Update git submodule assets_shared to v2.0.0-alpha.12 2024-05-13 18:16:18 +02:00
blender_extensions Thumbnails: flag toggling validation requirement 2024-04-26 11:50:55 +02:00
common UI: Slightly smaller permission heading 2024-05-17 11:52:05 +02:00
constants Thumbnails: change thumbnails format to WEBP 2024-05-09 01:18:31 +02:00
emails Admin: only show notification email previews in DEBUG 2024-05-02 14:20:22 +02:00
extensions Version History: Remove bottom margin on buttons 2024-05-16 19:23:14 +02:00
files Support for platforms and wheels (#131) 2024-05-16 18:20:41 +02:00
notifications Notifications: increase page size to 20 2024-05-14 22:36:34 +02:00
playbooks Playbooks: increase max body size 2024-05-14 17:26:25 +02:00
public/media Blender Kitsu: Updated manifest 2024-02-02 09:50:05 +01:00
ratings Implement Web Assets' theme system and selection, and add 'light' theme (#118) 2024-05-08 14:20:05 +02:00
releases Releases: Make 4.3 deactive by default 2024-02-18 15:52:16 +01:00
reviewers UI: Improve template extensions_review_detail activity item display 2024-05-16 12:10:18 +02:00
stats Tags: Make tags dependent on type, and remove taggit 2024-02-29 15:52:47 +01:00
teams UI: Make template team_list layout and style more consistent 2024-05-07 17:09:55 +02:00
users Admin: filter accounts by groups 2024-05-17 11:23:36 +02:00
.eslintignore Initial models, tests and other boilerplate 2022-08-25 17:37:48 +02:00
.eslintrc.js Initial models, tests and other boilerplate 2022-08-25 17:37:48 +02:00
.gitignore Playbooks: prepare production 2022-11-03 14:58:52 +01:00
.gitmodules UI: Web Assets v2 upgrade (#85) 2024-04-30 17:57:31 +02:00
.pre-commit-config.yaml Revert "Run API schema update as part of the pre-commit hook" 2024-02-20 19:25:56 +01:00
deploy.sh Make deploy.sh support extra arguments --check --diff 2024-02-29 18:14:52 +01:00
logo-source.svg Initial models, tests and other boilerplate 2022-08-25 17:37:48 +02:00
manage.py Initial models, tests and other boilerplate 2022-08-25 17:37:48 +02:00
pyproject.toml Initial models, tests and other boilerplate 2022-08-25 17:37:48 +02:00
README.md Mention libmagic as a requirement 2024-05-12 12:21:57 +02:00
requirements_dev.txt Revert "Deps: install faker and factory in prod too (used in the admin)" 2024-05-02 14:18:08 +02:00
requirements_prod.txt Replace gunicorn with uwsgi, use persistent db connections (#90) 2024-04-25 15:11:07 +02:00
requirements.txt Revert "Deps: install faker and factory in prod too (used in the admin)" 2024-05-02 14:18:08 +02:00
setup.cfg PEP: flake8 no longer supports inline comments in setup.cfg 2024-04-04 12:04:44 +02:00
utils.py Basic email template for notifications (#96) 2024-05-02 14:04:22 +02:00

blender-extensions-logo

Blender Extensions

Blender Extensions platform, heavily inspired by Mozilla's https://github.com/mozilla/addons-server.

Requirements

  • Python 3.10
  • libmagic: sudo apt-get install libmagic1 in Debian/Ubuntu, brew install libmagic on OSX.

Development

Extra requirements

  • virtualenv

Setup

Checkout Blender Web Assets submodule first:

git submodule update --init --recursive

Create and activate a virtual environment using your favourite method, e.g.

virtualenv .venv -p python
source .venv/bin/activate

Install required packages:

pip install -r requirements_dev.txt

Create the database tables and load some basic data to work with using the following commands:

./manage.py migrate
./manage.py loaddata **/fixtures/*.json

It's also possible to generate fake add-on data using the following command:

./manage.py generate_fake_data

Run development server

./manage.py runserver 8111

Update /etc/hosts to point to extensions.local, e.g.:

127.0.0.1	extensions.local

Now http://extensions.local:8111 should be ready to work with and it should be possible to log into http://extensions.local:8111/admin/ with admin/admin.

Blender ID

Blender Extensions, as all other Blender web services, uses Blender ID. Blender Extensions can also receive Blender ID account modifications such as badge updates via a webhook.

For development, Blender ID's code contains a fixture with an OAuth app and a webhook that should work without any changes to default configuration. To load this fixture, go to your development Blender ID and run the following:

./manage.py loaddata blender_extensions_devserver

N.B.: the webhook view delegates the actual updating of the user profile to a background task, so in order to see the updates locally, start the processing of tasks using the following:

./manage.py process_tasks

Blender ID and staging/production

For staging/production, create an OAuth2 application in Blender ID using Admin Blender-ID OAuth2 applications -> Add:

  • Redirect URIs: https://staging.extensions.blender.org/oauth/authorized (https://extensions.blender.org for production);
  • Client type: "Confidential";
  • Authorization grant type: "Authorization code";
  • Name: "Blender Extensions Staging" (or "Blender Extensions" for production);

Copy client ID and secret and save them as BID_OAUTH_CLIENT and BID_OAUTH_SECRET into a .env file:

export BID_OAUTH_CLIENT=<CLIENT ID HERE>
export BID_OAUTH_SECRET=<SECRET HERE>

Create a webhook using Admin Blender-ID API Webhooks > Add:

  • Name: "Blender Extensions Staging" (or "Blender Extensions" for production)";
  • URL: https://staging.extensions.blender.org/webhooks/user-modified/ (or https://extensions.blender.org/webhooks/user-modified/ for production);
  • App: choose the app created in the previous step;

Copy webhook's secret into the .env file as BID_WEBHOOK_USER_MODIFIED_SECRET:

export BID_WEBHOOK_USER_MODIFIED_SECRET=<WEBHOOK SECRET HERE>

Pre-commit hooks

Make sure to enable pre-commit hooks after installing requirements from requirements_dev.txt:

pre-commit install

This will enable formatting pre-commit checks for Django templates, Python and JS modules.

Testing

To simply run the test suit use

./manage.py test

To run tests and generate a coverage report use

coverage run manage.py test && coverage html

and then open htmlcov/index.html with your favourite browser.

Deploy

See playbooks.

Feature Flags

At the moment there are the following feature flags:

  • is_alpha
  • is_beta

To create them run

./manage.py waffle_switch --create is_alpha on

./manage.py waffle_switch --create is_beta off

They can optionally be setup on the deployment platform to set the release stage of the site. These settings will be removed once the site is officially launched.