As Epyk is a collaborative project, it is possible to create your own extensions based on your favorite Javascript modules. This will show you how to create, share and publish your packages to PYPI.
The naming convention for epyk extensions is epyk_x_%packageName%
Each package name is saved in this repository as a folder.
Some examples are available (they are already part of the core framework):
- js_datepicker
- json
The architecture of the framework is granular enought to be extended by bespoke compoents. The
By convention Epyk extensions are proper Python packages
You can use the setup.py script to create your package and upload it to pypi. Please make sure to communicate your changes to the community to ensure your code will be added to the core framework as part of the weekly releases.
The below line of code will load the components avaiable in the package and make it available in the page.ui entry point
from epyk.core.Page import Report
rptObj = Report()
rptObj.ui.extension('epyk_x_json', 'js')
dt = rptObj.ui.js.json_formatter({"test": 185})
rptObj.outs.html_file(path=config.OUTPUT_PATHS_LOCALS_HTML, name=config.OUT_FILENAME)The structure of a basic HTML component is as below.
It is defined in a class with a str method for the HTML representation. All the CSS styles and JavaScript common definition will be inherited from the Html base class.
It is also possible to add more complex components interacting different with JavaScript.
The below will add a specific behaviour on the dom object.
The below will add a specific behaviour on the JS part.
The target of this repository is more a lab with the various components implemented. This will also keep track of the changes and the various extension which should be added to the core framework.
Feel free to propose changes and create pull requests.
Bugs in the framework should be directly raised on the main repository.