Create and edit law collaboratively
Project description
Crowd Law
Preamble
What if citizens were to create laws for themselves? If from mass of people, experts and lawyers would participate in this process in a transparent way. Welcome to Crowd Law.
Introduction
What is this?
Tool to collaboratively create law, so anybody can do it. You can write new and edit existing documents, and you can use it for any other purpose. In other words - Git addon.
Why ?
In 2021 there is no good tool, to write documents by many people. Google Docs and Wiki does not provide good mechanisms for tracking and approving changes, which is crucial when creating transparent law. Computer programmers for a long time know benefits which come with Git system, but it is too complicated for non-technical person. This is why UI was made as easy as possible, to allow everybody use power of Git.
How ?
You edit all documents locally, and when you are ready you send changes to one of public servers. As they have tools, allowing to review, discuss and accept proposed changes, all review process is done on public server.
Installation
Download one of install packages for your system
Install and start using - app should be self-explanatory. If it is not, there is always room for improvement.
Example project
https://gitlab.com/gladykov/example-project-for-crowd-law
PyPi
PyPi module is intended only for preview / development purpose, as main channel of distribution should be provided installer.
pip install crowdlaw
I found an issue!
Great, please let me know: Fill Gitlab issue or drop me an email: gladykov gmail com
Documentation
Does not exist (yet)
Your projects live in HOME_DIRECTORY/.crowdlaw/
Contribution
There is still so much work to be done. From testing, translations, code review, refactoring, through building packages to adding new Git providers and developing new functionalities.
Packages preparation
Win:
pyinstaller main.spec --noconfirm --noconsole- then use inno setup
Translations
Right now supported languages are English and Polish. PLan is to allow translation of project in Crowdin
Roadmap ?
More like a wish list, as it depends on future needs of users and involvement of Open Source community:
- testing, testing, testing
- refactoring and review as this is initial work
- store credentials in more secure way
- Github adapter (right now only Gitlab is supported)
- utilising Markdown and WYSIWYM to create more rich text, which would still be easy to review by non-technical person
Underlying technology
Python + PySimpleGUI + GitPython + Gitlab API packages.
Debugging
Logs live in : HOME_DIR/.crowdlaw/crowdlaw.log
Code style
Blackd formatter and isort are your friends. Line-length 88. PRs are validated against them and finally by pycodestyle
License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
