{"id":13541926,"url":"https://github.com/jonathan-s/django-sockpuppet","last_synced_at":"2025-04-12T19:50:31.195Z","repository":{"id":37873754,"uuid":"239124136","full_name":"jonathan-s/django-sockpuppet","owner":"jonathan-s","description":"Build reactive applications with the django tooling you already know and love.","archived":false,"fork":false,"pushed_at":"2023-01-07T14:36:38.000Z","size":2667,"stargazers_count":452,"open_issues_count":34,"forks_count":23,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-04T01:06:12.420Z","etag":null,"topics":["django","django-channels","hacktoberfest","liveview","phoenix-liveview","python","reactive","stimulusreflex","websocket","websockets"],"latest_commit_sha":null,"homepage":"https://github.com/jonathan-s/django-sockpuppet","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonathan-s.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security.md","support":null},"funding":{"github":["jonathan-s"],"custom":["https://etherscan.io/address/0x6af511722f036dfbfae4adfe8e3c252f1336646c"]}},"created_at":"2020-02-08T11:52:48.000Z","updated_at":"2025-03-12T20:48:38.000Z","dependencies_parsed_at":"2023-02-07T10:46:01.724Z","dependency_job_id":null,"html_url":"https://github.com/jonathan-s/django-sockpuppet","commit_stats":null,"previous_names":["jonathan-s/sockpuppet"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathan-s%2Fdjango-sockpuppet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathan-s%2Fdjango-sockpuppet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathan-s%2Fdjango-sockpuppet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonathan-s%2Fdjango-sockpuppet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonathan-s","download_url":"https://codeload.github.com/jonathan-s/django-sockpuppet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625501,"owners_count":21135513,"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":["django","django-channels","hacktoberfest","liveview","phoenix-liveview","python","reactive","stimulusreflex","websocket","websockets"],"created_at":"2024-08-01T10:00:59.006Z","updated_at":"2025-04-12T19:50:31.176Z","avatar_url":"https://github.com/jonathan-s.png","language":"Python","funding_links":["https://github.com/sponsors/jonathan-s","https://etherscan.io/address/0x6af511722f036dfbfae4adfe8e3c252f1336646c"],"categories":["Python","Front-end frameworks"],"sub_categories":["More"],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003eWelcome to Sockpuppet 👋\u003c/h1\u003e\n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/django-sockpuppet\"/\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/sockpuppet-js.svg?color=blue\" /\u003e\n    \u003ca href=\"https://www.npmjs.com/package/sockpuppet-js\"\u003e\n      \u003cimg alt=\"downloads\" src=\"https://img.shields.io/npm/dm/sockpuppet-js.svg?color=blue\" target=\"_blank\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/jonathan-s/sockpuppet/blob/master/LICENSE\"\u003e\n      \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/badge/license-MIT-brightgreen.svg\" target=\"_blank\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://sockpuppet.argpar.se/\" target=\"_blank\"\u003e\n      \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/documentation-yes-brightgreen.svg\" /\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"#badge\"\u003e\n      \u003cimg alt=\"semantic-release\" src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\"\u003e\n    \u003c/a\u003e\n    \u003cimg src=\"https://travis-ci.org/jonathan-s/django-sockpuppet.svg?branch=master\" alt=\"Tests\"\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n### 🎉 **You just discovered an exciting new way to build modern, reactive, real-time apps with Django.**\n\n**Why should I spend time exploring this?** If you use current frontend libraries, such as react, vue or angular you end up creating state for the frontend and then updating state changes in the backend through an api.\n\nThis means that you forgo server-rendered html with the advantages that brings + you'll end up with a more complex app overall.\n\nWith this library you can still use normal django templates, and any frontend state you change will be directly reflected in the backend. Currently this happens through the use of websockets.\n\nThis is the django implementation of the excellent rails library [stimulus-reflex][1], which in turn is inspired by [Phoenix LiveView][2].\n\nHit me up on twitter if you have any questions.  [![Twitter follow](https://img.shields.io/twitter/follow/argparse?style=social)](https://twitter.com/argparse)\n\n## 📚 Documentation\n\n- [Official Documentation](https://sockpuppet.argpar.se/)\n\n## ⚡️ Get started\n\n```bash\npip install django-sockpuppet\n\n# If performance is important you can take advantage lxml parsing\n# It will typically speed up the round trip by 30-90ms depending on the html\npip install django-sockpuppet[lxml]\n\n# Add these into INSTALLED_APPS in settings.py\nINSTALLED_APPS = [\n    'channels',\n    'sockpuppet'\n]\n\n# generates scaffolding for webpack.config.js and installs required js dependencies\n# if you prefer to do that manually read the more thorough documentation\npython manage.py initial_sockpuppet\n\n# scaffolds a new reflex with everything that's needed.\npython manage.py generate_reflex app_name name_of_reflex\n```\n\nYou're almost there, read about how to tie it all together in the [quickstart documentation][3]\n\n## 💙 Community\n\n- [Discord](https://discord.gg/XveN625) - We share the discord together with stimulus-reflex, and there is a channel dedicated for python/django discussions.\n- [django-sockpuppet-expo](https://github.com/zodman/django-sockpuppet-expo) - Do you want more examples? There code examples of chats, book search, etc ... We accept PRs :)\n\n\n## 🛠 Development in the repo\n\nSee some common commands that can be useful for development\n\n```bash\npip install -r requirements_dev.txt\ninvoke -l\n```\n\nTry out a minimal example manually\n\n```\ngit clone git@github.com:jonathan-s/django-sockpuppet.git\nnpm install\nnpm run build:test\npython manage.py runserver\n# visit https://localhost:8000/test\n```\n\n## ⛑ Running tests locally\nThe most important tests are integration tests that makes sure that frontend and backend work together in conjunction with each other.\n\n```\n# Install the cypress et al\nnpm install\n\n# Spin up a dev server that uses some fixtures\ninv test-server\n\n# Run the cypress tests\nnpm run cypress:run\n```\n\n\n## 🔜 Release\n\n```\npip install -r requirements_dev.txt\ninvoke release -b feature\n```\n\n[1]: https://github.com/hopsoft/stimulus_reflex\n[2]: https://youtu.be/Z2DU0qLfPIY?t=670\n[3]: https://sockpuppet.argpar.se/quickstart-django\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonathan-s%2Fdjango-sockpuppet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonathan-s%2Fdjango-sockpuppet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonathan-s%2Fdjango-sockpuppet/lists"}