Difference between revisions of "Py-yprinciple-gen"
Jump to navigation
Jump to search
| (21 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
|title=py-yprinciple-gen | |title=py-yprinciple-gen | ||
|url=https://github.com/WolfgangFahl/py-yprinciple-gen | |url=https://github.com/WolfgangFahl/py-yprinciple-gen | ||
| − | |version=0. | + | |version=0.4.3 |
|description=python Y-Principle generator | |description=python Y-Principle generator | ||
| − | |date= | + | |date=2025-09-19 |
| − | |since=2022-11- | + | |since=2022-11-27 |
|storemode=property | |storemode=property | ||
}} | }} | ||
| + | |||
| + | = Motivation = | ||
| + | BITPlan has been proposing the {{Link|target=Y-Principle}} since it's inception in 1999. | ||
| + | |||
| + | When we started using [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic MediaWiki] in 2013 we needed a way to apply the principle to the usage of SMW. | ||
| + | |||
| + | We therefore implemented the [https://www.semantic-mediawiki.org/wiki/Metadata_management#ProfiWiki ProfiWiki approach] which was first implemented in Java. | ||
| + | |||
| + | This project is a migration of the Java based solution to Python and using the reactive approach [https://justpy.io/ justpy] which does not need a separate javascript frontend | ||
| + | but uses "remote DOM rewriting" instead. | ||
| + | |||
=tickets= | =tickets= | ||
| − | = | + | {{pip|py-yprinciple-gen}} |
| + | |||
| + | = Usage = | ||
| + | == Command line == | ||
| + | <source lang='bash'> | ||
| + | ypgen -h | ||
| + | usage: ypgen [-h] [--about] [--context CONTEXT] [-d] [--host HOST] [--port PORT] [--serve] [--wikiId WIKIID] [-V] | ||
| + | |||
| + | python Y-Principle generator | ||
| + | |||
| + | Created by Wolfgang Fahl on 2022-11-24. | ||
| + | Copyright 2022 Wolfgang Fahl. All rights reserved. | ||
| + | |||
| + | Licensed under the Apache License 2.0 | ||
| + | http://www.apache.org/licenses/LICENSE-2.0 | ||
| + | |||
| + | Distributed on an "AS IS" basis without warranties | ||
| + | or conditions of any kind, either express or implied. | ||
| + | |||
| + | USAGE | ||
| + | |||
| + | options: | ||
| + | -h, --help show this help message and exit | ||
| + | --about show about info [default: False] | ||
| + | --context CONTEXT context to generate from [default: MetaModel] | ||
| + | -d, --debug show debug info [default: False] | ||
| + | --host HOST the host to serve / listen from [default: fix.bitplan.com] | ||
| + | --port PORT the port to serve from [default: 8778] | ||
| + | --serve start webserver | ||
| + | --wikiId WIKIID id of the wiki to generate for [default: wiki] | ||
| + | -V, --version show program's version number and exit | ||
| + | </source> | ||
Latest revision as of 12:47, 19 September 2025
OsProject
| OsProject | |
|---|---|
| id | py-yprinciple-gen |
| state | active |
| owner | WolfgangFahl |
| title | py-yprinciple-gen |
| url | https://github.com/WolfgangFahl/py-yprinciple-gen |
| version | 0.4.3 |
| description | python Y-Principle generator |
| date | 2025-09-19 |
| since | 2022-11-27 |
| until | |
Motivation
BITPlan has been proposing the Y-Principle since it's inception in 1999.
When we started using Semantic MediaWiki in 2013 we needed a way to apply the principle to the usage of SMW.
We therefore implemented the ProfiWiki approach which was first implemented in Java.
This project is a migration of the Java based solution to Python and using the reactive approach justpy which does not need a separate javascript frontend but uses "remote DOM rewriting" instead.
tickets
Installation
pip install py-yprinciple-gen
# alternatively if your pip is not a python3 pip
pip3 install py-yprinciple-gen
# local install from source directory of py-yprinciple-gen
pip install .
upgrade
pip install py-yprinciple-gen -U
# alternatively if your pip is not a python3 pip
pip3 install py-yprinciple-gen -U
Usage
Command line
ypgen -h
usage: ypgen [-h] [--about] [--context CONTEXT] [-d] [--host HOST] [--port PORT] [--serve] [--wikiId WIKIID] [-V]
python Y-Principle generator
Created by Wolfgang Fahl on 2022-11-24.
Copyright 2022 Wolfgang Fahl. All rights reserved.
Licensed under the Apache License 2.0
http://www.apache.org/licenses/LICENSE-2.0
Distributed on an "AS IS" basis without warranties
or conditions of any kind, either express or implied.
USAGE
options:
-h, --help show this help message and exit
--about show about info [default: False]
--context CONTEXT context to generate from [default: MetaModel]
-d, --debug show debug info [default: False]
--host HOST the host to serve / listen from [default: fix.bitplan.com]
--port PORT the port to serve from [default: 8778]
--serve start webserver
--wikiId WIKIID id of the wiki to generate for [default: wiki]
-V, --version show program's version number and exit