{"id":16739554,"url":"https://github.com/puria/ksweb","last_synced_at":"2025-07-23T14:32:08.994Z","repository":{"id":30818869,"uuid":"114178096","full_name":"puria/ksweb","owner":"puria","description":"Knowledge Shaper. The editor to share your knowledge.","archived":false,"fork":false,"pushed_at":"2023-03-06T05:02:39.000Z","size":13486,"stargazers_count":28,"open_issues_count":45,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-18T05:34:52.042Z","etag":null,"topics":["algorithms-datastructures","fossa-status","knowledge","knowledge-representation","knowledgebase","lawyer","legal-documents","legaltech","puria","python","tree-of-savior","turbogears2"],"latest_commit_sha":null,"homepage":"http://ks.studiolegale.it","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/puria.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-13T23:06:56.000Z","updated_at":"2025-01-05T13:36:07.000Z","dependencies_parsed_at":"2024-10-28T11:36:39.461Z","dependency_job_id":"b30a13c9-8b10-4c5f-9e49-df7205c8a094","html_url":"https://github.com/puria/ksweb","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puria%2Fksweb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puria%2Fksweb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puria%2Fksweb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/puria%2Fksweb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/puria","download_url":"https://codeload.github.com/puria/ksweb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244880196,"owners_count":20525505,"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":["algorithms-datastructures","fossa-status","knowledge","knowledge-representation","knowledgebase","lawyer","legal-documents","legaltech","puria","python","tree-of-savior","turbogears2"],"created_at":"2024-10-13T00:52:03.710Z","updated_at":"2025-03-21T22:31:32.378Z","avatar_url":"https://github.com/puria.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ksweb\n\n[![Build Status](https://travis-ci.org/puria/ksweb.svg?branch=master)](https://travis-ci.org/puria/ksweb)\n[![Coverage Status](https://coveralls.io/repos/github/puria/ksweb/badge.svg?branch=master)](https://coveralls.io/github/puria/ksweb?branch=master)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpuria%2Fksweb.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fpuria%2Fksweb?ref=badge_shield)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\nThe **KS** (Knowledge Shaper) is a [Document Automation](https://en.wikipedia.org/wiki/Document_automation) digital product that enables the shaping and reuse of Knowledge Bases. Our effort is to allow and facilitate the creation of wizards that easily outputs documents just by answering to simple questions with an extra effort to a functiona design and UX.\n\nYou can try the demo online available on [ks.studiolegale.it](http://ks.studiolegale.it).\nSome example of Knowledge Bases are:\n \n * [Memorandum on GDPR compliance](https://github.com/marco55555/Memorandum-GDPR)\n * [Lawyer quotation (in italian)](https://github.com/marco55555/preventivo_avvocato)\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003cstrong\u003e:triangular_flag_on_post: Table of Contents\u003c/strong\u003e (click to expand)\u003c/summary\u003e\n\n* [Getting started](#whale-getting-started)\n* [Manual Installation](#floppy_disk-manual-installation-for-advanced-users)\n* [Usage](#video_game-usage)\n* [Configuration](#wrench-configuration)\n* [I18n](#globe_with_meridians-I18n)\n* [Notes](#memo-notes)\n* [Troubleshooting \u0026 debugging](#bug-troubleshooting--debugging)\n* [Acknowledgements](#heart_eyes-acknowledgements)\n* [Contributing](#busts_in_silhouette-contributing)\n* [License](#briefcase-license)\n\u003c/details\u003e\n\n## :whale: Getting started\n\nThe easiest way to run ksweb is inside a docker container. just run\n\n    git clone --recursive https://github.com/puria/ksweb.git\n\tcd ksweb\n    docker-compose up\n\nFor instructions about how to install `docker-compose` please refere to the \n[official documentation](https://docs.docker.com/compose/install/) \n\n## :floppy_disk: Manual Installation (for advanced users)\n\nCheckout the project\n\n    git clone --recursive https://github.com/puria/ksweb.git\n\n### Pre-requisites\nBefore install KSweb you need to have an instance of **[:leaves:mongodb](https://www.mongodb.com/download-center/community)** up and running, the **python development headers** and **python3-virtualenv** packages\n*NB* you need `python3 \u003e= 3.6` and `pip \u003e= 18.1`\n\nYou also need to have to install [pandoc](https://pandoc.org/) for exporting the actual output to different formats.\n\n### Installer\nrun the installer:\n\n:apple: macosx\n\n    brew install python3\n    cd ksweb\n    ./install\n\n:penguin: debian derivatives\n\n    apt install python3-dev python3-virtualenv\n    cd ksweb\n    ./install\n\n### Manual installation\n\n[![asciicast](https://asciinema.org/a/yImfeZTmmoGWvXV93k3g0OtaO.png)](https://asciinema.org/a/yImfeZTmmoGWvXV93k3g0OtaO)\n\n\nInstall ``ksweb`` using the setup.py script\n\n```bash\n    # Enter into the first project folder\n    $ cd ksweb\n    \n    # Create a virtual environment for python2 (important)\n    $ virtualenv -p python2 venv\n    \n    # Activate your virtual environment (very important)\n    $ source venv/bin/activate\n    \n    # Enter the subproject folder\n    $ cd ksweb\n    \n    # Install all the dependencies\n    $ pip install -e .\n    \n    # Populate the mandatory data (TO RUN JUST AT THE FIRST USAGE OF A DATABASE)\n    $ gearbox setup-app\n```\n\nStart the http server\n\n```bash\n # Start a local webserver (NOT SUITABLE FOR PRODUCTION) \n $ gearbox serve --reload\n```\n\nThen you are ready to go :tada:\n\n***\n## :video_game: Usage\n\nTo run the webapp activate your virtualenv and run the server:\n\n    cd ksweb\n    source venv/bin/activate\n    gearbox serve\n\nand head your browser to `http://localhost:8080`\n\n\nDefault accounts (username - password):\n\n  Administrator: admin :key: adminks\n  \n  Lawyer: lawyer :key: lawyerks\n  \n  User: user :key: userks\n\n***\n## :wrench: Configuration\n\nThe conf files are `development.ini` and `test.ini`.\n\nThe most effective way is to edit the file and tweak stuff. Salient info are reported below.\n\n### :leaves: MongoDB \n\nThe url of the database connection is `ming.url` find it in `development.ini` and change it per your needs.\n\n***\n\n## :globe_with_meridians: I18n\n\nThe UI of the knowledge shaper is already translated in English and Italian.\nIf you need othe languages, please indicate us someone who wants to help, and\nopen and issue.\nThe extensive documentation about how the translation works is available on \n[this section](https://turbogears.readthedocs.io/en/latest/turbogears/i18n.html)\nof the Turbogears official site.\n\nIn briefe allows to:\n\n  * Create a new language (also called `Catalog`)\n  * Extract the strings from the software\n  * Update and Compile existing language/catalog\n\nThe catalogs are simple `.po` files that anyone can open with a translation\nsoftware (eg. [Poedit](https://poedit.net/))\n\n\n***\n## :memo: Notes\n\n***\n## :bug: Troubleshooting \u0026 debugging\n\nTo run the app in debug mode launch the server with the following flags\n\n    gearbox serve --debug --reload\n\n\n***\n## :heart_eyes: Acknowledgements\n\nCopyright (C) 2018 by StudioLegale.it \u003chttp://studiolegale.it\u003e\n\nDesigned, written by AXANT.it and currently maintained by Puria Nafisi Azizi.\n\n***\n## :busts_in_silhouette: Contributing\n\n1. [FORK IT](https://github.com/puria/ksweb/fork)\n1. Create your feature branch `git checkout -b feature/branch`\n1. Commit your changes `git commit -am 'Add some fooBar'`\n1. Push to the branch `git push origin feature/branch`\n1. Create a new Pull Request\n1. Thank you\n\n***\n## :briefcase: License\n\n    Knowledge Shaper, Collaborative knowledge tools editor\n    Copyright (c) 2017-TODAY StudioLegale.it \u003chttp://studiolegale.it\u003e\n                             AXANT.it \u003chttp://axant.it\u003e\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU Affero General Public License as\n    published by the Free Software Foundation, either version 3 of the\n    License, or (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU Affero General Public License for more details.\n\n    You should have received a copy of the GNU Affero General Public License\n    along with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpuria%2Fksweb.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fpuria%2Fksweb?ref=badge_large)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpuria%2Fksweb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpuria%2Fksweb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpuria%2Fksweb/lists"}