Metadata-Version: 2.4
Name: flatwiki
Version: 0.1.1
Summary: A lightweight wiki engine without databases
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: argon2-cffi==25.1.0
Requires-Dist: argon2-cffi-bindings==25.1.0
Requires-Dist: blinker==1.9.0
Requires-Dist: cffi==2.0.0
Requires-Dist: click==8.4.1
Requires-Dist: colorama==0.4.6
Requires-Dist: flask==3.1.3
Requires-Dist: itsdangerous==2.2.0
Requires-Dist: jinja2==3.1.6
Requires-Dist: markdown==3.10.2
Requires-Dist: markupsafe==3.0.3
Requires-Dist: pycparser==3.0
Requires-Dist: pyyaml==6.0.3
Requires-Dist: waitress==3.0.2
Requires-Dist: webencodings==0.5.1
Requires-Dist: werkzeug==3.1.8
Dynamic: license-file

# FlatWiki

## About

FlatWiki is a lightweight wiki engine. A FlatWiki is not your traditional wiki: it doesn't use any databases nor docker and is easy to set up on any machine with Python and pip. Simply pip install it, use the wizard to create a config file, and fire up the server! Then, you'll have a full wiki where you can log in to the administrator portal to modify, add, and delete pages to serve documents, instructions, or anything else to users.

## Installation and Usage

### Installation

1. Install via pip. Common commands are: `pip install flatwiki`, `pip3 install flatwiki`, `pipx install flatwiki`.
2. Navigate to a directory you would like to run flatwiki in.
3. Run `flatwiki config` and answer the prompts.
4. Run `flatwiki create-user` and add a administrator for you to log in as.
5. Run `flatwiki` to start the server!

### Usage

While the server is running, the root directory is public and users can browse the pages that admins created. By clicking `Admin Login` below the page names, you can see the admin portal. Log in with authorized credentials and then you will be greeted with a intuitive dashboard where you can create, edit, and delete pages.
