aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e0127efb526cce5c3f8a93217a827f0c56eea883 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# A personal Wiki

I like wikis and I find them fascinating. Every now and then I feel like I should do something about it.

So this is an attempt to make a personal wiki in Python (with [bottle](https://bottlepy.org/)).

This is *a work in progress* and is not finished (it may never be!).

# How to use it

Why would you want to use this? OK, go on.

* Create a virtual enviromement
* Install the dependencies using pip
* run `wiki,py`

For example:

1. `python3 -m venv ENV`
2. `source ENV/bin/activate`
3. `pip install -r requirements.txt`
4. `python3 wiki.py`

The configuration should be in `wiki.conf` (not much at the moment), and the logger configuraion is in `logger.json`.

# Licence

My code is licensed [GPL 3.0](gpl-3.0.txt).

`bottle_sqlite.py` is licensed MIT and it is included here because it has a fix regarding API changes in Python 3.x. Read the file for further details.