| Name | otterwiki JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | |
| Summary | An Otter Wiki is Python-based software for collaborative content management, called a wiki. The content is stored in a git repository, which keeps track of all changes. Markdown is used as markup language. |
| upload_time | 2024-03-07 22:54:29 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2022 Ralph Thesen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
wiki
git
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# An Otter Wiki
An Otter Wiki is Python-based software for collaborative content
management, called a [wiki](https://en.wikipedia.org/wiki/Wiki). The
content is stored in a git repository, which keeps track of all changes.
[Markdown](https://daringfireball.net/projects/markdown) is used as
Markup language. An Otter Wiki is written in [python](https://www.python.org/)
using the microframework [Flask](http://flask.pocoo.org/).
[halfmoon](https://www.gethalfmoon.com) is used as CSS framework
and [CodeMirror](https://codemirror.net/) as editor.
[Font Awesome Free](https://fontawesome.com/license/free) serves the icons.
## Notable Features
- Minimalistic interface (with dark-mode)
- Editor with markdown highlighting and support including tables
- Full changelog and page history
- User authentication
- Page Attachments
- A very cute Otter as logo (drawn by [Christy Presler](http://christypresler.com/) CC BY 3.0).
## Demo
Check out the demo <https://demo.otterwiki.com>.
## Installation
Read the [installation guide](https://otterwiki.com/Installation) to get
started. Recommended is the installation with `docker-compose`.
### Quick start with docker-compose
1. Copy and edit the `docker-compose.yml` below to match your preferences.
2. Run `docker-compose up -d`
3. Access the wiki via http://127.0.0.1:8080 if run on your machine.
4. If the wiki shall be accessible via the internet and an domain name make sure to configure your web server accordingly. Check the [installation guide](https://otterwiki.com/Installation#reverse-proxy) for example configurations for nginx, apache and caddy.
5. Register your account. The first account is an admin-account giving you access to the settings tab.
6. Customize the settings to your liking.
Proceed for the [configuration guide](https://otterwiki.com/Configuration) for
detailed information.
#### docker-compose.yml
```yaml
version: '3'
services:
otterwiki:
image: redimp/otterwiki:2
restart: unless-stopped
ports:
- 8080:80
volumes:
- ./app-data:/app-data
```
## License
An Otter Wiki is open-source software licensed under the [MIT License](https://github.com/redimp/otterwiki/blob/main/LICENSE).
[modeline]: # ( vim: set fenc=utf-8 spell spl=en sts=4 et tw=72: )
Raw data
{
"_id": null,
"home_page": "",
"name": "otterwiki",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "wiki,git,markdown",
"author": "",
"author_email": "Ralph Thesen <mail@redimp.de>",
"download_url": "https://files.pythonhosted.org/packages/f1/ff/97b655dc8ab8d95b603fbbfcb3392fdc3dc99f4ec092d76efacee043a75e/otterwiki-2.2.0.tar.gz",
"platform": null,
"description": "\n\n# An Otter Wiki\n\nAn Otter Wiki is Python-based software for collaborative content\nmanagement, called a [wiki](https://en.wikipedia.org/wiki/Wiki). The\ncontent is stored in a git repository, which keeps track of all changes.\n[Markdown](https://daringfireball.net/projects/markdown) is used as\nMarkup language. An Otter Wiki is written in [python](https://www.python.org/)\nusing the microframework [Flask](http://flask.pocoo.org/).\n[halfmoon](https://www.gethalfmoon.com) is used as CSS framework\nand [CodeMirror](https://codemirror.net/) as editor.\n[Font Awesome Free](https://fontawesome.com/license/free) serves the icons.\n\n## Notable Features\n\n- Minimalistic interface (with dark-mode)\n- Editor with markdown highlighting and support including tables\n- Full changelog and page history\n- User authentication\n- Page Attachments\n- A very cute Otter as logo (drawn by [Christy Presler](http://christypresler.com/) CC BY 3.0).\n\n## Demo\n\nCheck out the demo <https://demo.otterwiki.com>.\n\n## Installation\n\nRead the [installation guide](https://otterwiki.com/Installation) to get\nstarted. Recommended is the installation with `docker-compose`.\n\n### Quick start with docker-compose\n\n1. Copy and edit the `docker-compose.yml` below to match your preferences.\n2. Run `docker-compose up -d`\n3. Access the wiki via http://127.0.0.1:8080 if run on your machine.\n4. If the wiki shall be accessible via the internet and an domain name make sure to configure your web server accordingly. Check the [installation guide](https://otterwiki.com/Installation#reverse-proxy) for example configurations for nginx, apache and caddy.\n5. Register your account. The first account is an admin-account giving you access to the settings tab.\n6. Customize the settings to your liking.\n\nProceed for the [configuration guide](https://otterwiki.com/Configuration) for\ndetailed information.\n\n#### docker-compose.yml\n\n```yaml\nversion: '3'\nservices:\n otterwiki:\n image: redimp/otterwiki:2\n restart: unless-stopped\n ports:\n - 8080:80\n volumes:\n - ./app-data:/app-data\n```\n\n## License\n\nAn Otter Wiki is open-source software licensed under the [MIT License](https://github.com/redimp/otterwiki/blob/main/LICENSE).\n\n[modeline]: # ( vim: set fenc=utf-8 spell spl=en sts=4 et tw=72: )\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Ralph Thesen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "An Otter Wiki is Python-based software for collaborative content management, called a wiki. The content is stored in a git repository, which keeps track of all changes. Markdown is used as markup language.",
"version": "2.2.0",
"project_urls": {
"Demo": "https://demo.otterwiki.com",
"homepage": "https://otterwiki.com",
"issues": "https://github.com/redimp/otterwiki/issues/",
"repository": "https://github.com/redimp/otterwiki"
},
"split_keywords": [
"wiki",
"git",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd31b4d21c648e37145e7a80f67c7fe1eae09181d9d7f61cbef596ef744c87d6",
"md5": "d3d40b2549b77954fee219521b50670e",
"sha256": "9e8a4a999b27d1edd9cbd5846e7db38df29d0aa83ec5b1d85afe29c53c63a28f"
},
"downloads": -1,
"filename": "otterwiki-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3d40b2549b77954fee219521b50670e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7070302,
"upload_time": "2024-03-07T22:54:25",
"upload_time_iso_8601": "2024-03-07T22:54:25.936241Z",
"url": "https://files.pythonhosted.org/packages/cd/31/b4d21c648e37145e7a80f67c7fe1eae09181d9d7f61cbef596ef744c87d6/otterwiki-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1ff97b655dc8ab8d95b603fbbfcb3392fdc3dc99f4ec092d76efacee043a75e",
"md5": "444580610194b1c47ed10dfafd79053e",
"sha256": "1695319b3b2f2cc8abb190b832faa15e91b159b842c0ffd2a08205ca76a09fac"
},
"downloads": -1,
"filename": "otterwiki-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "444580610194b1c47ed10dfafd79053e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7110004,
"upload_time": "2024-03-07T22:54:29",
"upload_time_iso_8601": "2024-03-07T22:54:29.711149Z",
"url": "https://files.pythonhosted.org/packages/f1/ff/97b655dc8ab8d95b603fbbfcb3392fdc3dc99f4ec092d76efacee043a75e/otterwiki-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-07 22:54:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "redimp",
"github_project": "otterwiki",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"lcname": "otterwiki"
}
