{"id":20209903,"url":"https://github.com/epykure/epyk-studio","last_synced_at":"2025-04-10T13:14:33.488Z","repository":{"id":57426798,"uuid":"286077763","full_name":"epykure/epyk-studio","owner":"epykure","description":"A simple way to create rich interactive websites and dashboards compatible with modern web frameworks","archived":false,"fork":false,"pushed_at":"2022-02-18T00:35:00.000Z","size":2651,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T11:56:55.973Z","etag":null,"topics":["dashboards","javascript","python","website"],"latest_commit_sha":null,"homepage":"http://www.epyk.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/epykure.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-08T16:19:43.000Z","updated_at":"2024-06-21T13:36:21.000Z","dependencies_parsed_at":"2022-09-19T06:41:18.538Z","dependency_job_id":null,"html_url":"https://github.com/epykure/epyk-studio","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epykure%2Fepyk-studio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epykure%2Fepyk-studio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epykure%2Fepyk-studio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epykure%2Fepyk-studio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/epykure","download_url":"https://codeload.github.com/epykure/epyk-studio/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225649,"owners_count":21068078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboards","javascript","python","website"],"created_at":"2024-11-14T05:43:20.250Z","updated_at":"2025-04-10T13:14:33.207Z","avatar_url":"https://github.com/epykure.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\nPresentation\n================================\nEpyk-studio is a module on top of Epyk-ui that has been created to facilitate the use of the various features available.\nSince Epyk-ui is the transpiler to Javascript and web artifacts, only a few components (around 200) are available.\n\nEpyk-studio will facilitate the use of components by using pre-defined styles according to the type of websites.\nEpyk-studio also provides some helpers and shortcuts to design:\n\n- blog pages\n- event pages\n- shops pages\n- ad for app\n- pictures / videos gallery\n\n\nThose pages will generate proper HYML pages which can then be hosted by any company.\nThere is no need to buy something specific to use Epyk nor to publish your work.\n\n\nQuickstart\n================================\n\nAs Epyk-studio is still only available as a Python package, you would need to follow the below steps in order to use it:\n\nInstall Epyk\n\n\u003e pip install epyk_studio\n\n#### From the internal Server\n\nOnce installed on your Python distribution, run the below command in any folder you want to user as project path.\nThe below options will run it using localhost address without the debug mode.\n\n```cmd\n%python%\\scripts\\epyk_studio.exe run -l=Y -d=N\n```\n\nThis should start a terminal and page will be accessible from your browser.\nThe pages should guide you in the design of your web application.\n\n#### From Python IDE\n\nCreate a web page\n\n```py\nfrom epyk_studio.core.Page import Report#\n\npage = Report()\npage.headers.dev()\n\npage.ui.title(\"Print messages\")\n\nurl = \"https://raw.githubusercontent.com/jbrownlee/Datasets/master/iris.csv\"\nnames = ['sepal-length', 'sepal-width', 'petal-length', 'petal-width', 'class']\ndataset = pandas.read_csv(url, names=names)\n\npage.ui.title(\"Dataset\")\n\nt1 = page.studio.dashboard.table(dataset.to_dict('records'))\n```\nTranspile your reports\n\n\u003e python epyk_studio transpile\n\nUsage\n======\n\nThe idea of this module is to never leave Python until the end of the product.\nBy using this module there is no need to move to Javascript or even worse to start learning TypeScript to create safe and modern webpages.\n\nThis will allow you to make the bridge between Python and Javascript and then to reuse both rich ecosystems.\nEverything which is close to Javascript will be using the Javascript naming conventions.\n\nEpyk studio can be used for any kind of project from personal ones to professional ones when dashboards are needed.\nThanks to this module and its design it will be easy to change layouts and to switch the display according to your audience (without changing code or technology).\n\n\u003cb\u003e\u003ci\u003e\nIn the below examples, assets are coming from existing websites. This is only to illustrate some features available in the \npackage.\n\u003c/i\u003e\n\u003c/b\u003e\n\nFor example Epyk Studio can be used in the below cases:\n\nTo generate **dashboards** (for time management, data monitoring, machine learning algorithms...)\n\n\u003cdiv align=\"center\" \u003e\n    \u003cimg width=600 src=\"https://github.com/epykure/epyk-studio/blob/master/static/dashboards.PNG?raw=true\"\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\" \u003e\n    \u003cimg width=600 src=\"https://github.com/epykure/epyk-studio/blob/master/static/tracking.PNG?raw=true\"\u003e\n\u003c/div\u003e\n\nExamples:\n\n[management.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/management.py)\n[news.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/news.py)\n[tracking.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/tracking.py)\n\n\nTo generate **modern websites** (for a restaurant, hotel or a specific private event)\n\n\u003cdiv align=\"center\" \u003e\n    \u003cimg width=600 src=\"https://github.com/epykure/epyk-studio/blob/master/static/foods.PNG?raw=true\"\u003e\n\u003c/div\u003e\n\nExamples:\n\n[travel.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/travel.py)\n[hotel.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/hotel.py)\n[wedding.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/wedding.py)\n\n\nTo generate **shopping websites** (for e-commerce websites)\n\n\u003cdiv align=\"center\" \u003e\n    \u003cimg width=600 src=\"https://github.com/epykure/epyk-studio/blob/master/static/shops.PNG?raw=true\"\u003e\n\u003c/div\u003e\n\nExamples:\n\n[shop.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/shop.py)\n[dance.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/dance.py)\n[vitrin.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/vitrin.py)\n\n\nTo generate **slides** (for dynamic and rich presentations)\n\n\u003cdiv align=\"center\" \u003e\n    \u003cimg width=600 src=\"https://github.com/epykure/epyk-studio/blob/master/static/slides.PNG?raw=true\"\u003e\n\u003c/div\u003e\n\nExamples:\n\n[europython](https://github.com/epykure/epyk-templates/blob/master/slides/20200725_sprint_europython.py)\n[blog.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/blog.py)\n[gallery.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/gallery.py)\n\nTo teach Python\n\n\u003cdiv align=\"center\" \u003e\n    \u003cimg width=600 src=\"https://github.com/epykure/epyk-studio/blob/master/static/teaching.PNG?raw=true\"\u003e\n\u003c/div\u003e\n\nExamples:\n\n[learning.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/learning.py)\n[image_processing.py](https://github.com/epykure/epyk-templates/blob/master/locals/studio/image_processing.py)\n\n\n\u003ch2 style=\"text-align:center\"\u003e\nA simple and efficient way to prototype and share your work !\n\u003c/h2\u003e\n\nThis can also work with Jupyter and JupyterLab. More details [here](https://github.com/epykure/epyk-templates-notebooks).\n\nNext features\n==================\n\nThe Epyk Studio team will be working on:\n\n1. building an online portal to start prototyping directly from the browser.\n2. integrating Native application features for the migration to apps\n3. building the community\n4. creating tutorials and examples\n\nAs this is a collaborative project, pleasde do not hesitate to let us know about your interest and also to share your feedback.\n\nYou can also have a look at the main templates and examples repository [here](https://github.com/epykure/epyk-templates).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fepykure%2Fepyk-studio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fepykure%2Fepyk-studio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fepykure%2Fepyk-studio/lists"}