valitydev/redash
14
0
Fork 0
mirror of https://github.com/valitydev/redash.git synced 2024-11-07 01:25:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ff34dedf46
redash/tests/extensions/redash-dummy/README.md
Jannis Leidel 7b5696dc75 Fix loading of periodic tasks and clean up extension loading. (#4064) 
* Fix loading of periodic tasks and clean up extension loading.

This does a few things:

- add tests for extension loading
- refactor the extension and periodic task loading
- better handle assertions raised by extensions (e.g. when an extension tries to override an already registered view)
- attach exception traceback to error log during loading for improved debugging

* Use site.addsitedir instead of calling pip.

* Use sys.path instead of site.addsitedir and also the setup.py egg_info command.
2019-08-13 13:11:59 +03:00

1.0 KiB
Raw Blame History

How to update the dummy extension?

If you'd like to extend the dummy extension, please update the setup.py file and the redash_dummy.py module.

Please make sure to regenerate the *.egg-info directory. See below.

How to generate the redash_dummy.egg-info directory?

The egg-info directory is what is usually created in the site-packages directory when running pip install <packagename> and contains the metadata derived from the setup.py file.

In other words, it's auto-generated and you'll need to follow the following steps to update it (e.g. when extending the extension tests). From the host computer (assuming the Docker development environment) run:

  • make bash -- to create container running with Bash and entering it
  • cd tests/extensions/redash-dummy/ -- change the directory to the directory with the dummy extension
  • python setup.py egg_info -- to create/update the egg-info directory

The egg-info directory is not cleaned up by pip, just the link in the ~/.local site-packages directory.