Home

Awesome

Pervane | Demo | Install & Run | Wiki | Discuss

Pervane is a plain text file based note taking and knowledge base building tool. It doubles as simple file server to render given directories files in web browser while it can be used as a cloud IDE too with awesome code highlighting. It's like python's built-in SimpleHTTPServer but a little bit feature richer like WYSIWYG note taking experience, sidebar with infinite number of nesting, blazing fast text search, file moving, creating from the browser etc.

Main use case is to create, edit, serve and search the markdown notes in combination with example source files.

If you are using plain text based note taking, this can be helpful for adhoc mediums like operating systems which don't have large desktop app ecosystem like ChromeOS or mobile OS like Android and iOS.

Features

Screenshots

Generel view of the app

All of the screenshots and more video are located in Pervane Wiki.

Install via pip

screen
pip install pervane

# First make sure you create the admin user
pervane --mode=init

# Then run the app for reals.
# You can login with your recently created credentials.
pervane --dir=example/

When you go to localhost:5000, Pervane only accepts 1 user. So your notes will only be visible by this single user.

⚠️ If you see a server error, delete your cookies and retry.

If you are upgrading from a version before 0.0.9

You will probably see errors about user is not existing. You need to run pervane --mode=init first. I've changed user auth mode again (had to, because flask-user is deprecated). Sorry about it.

Package details here: https://pypi.org/project/pervane/

You can run Pervane also with Docker or build it from source. Please visit Pervane Wiki for more installation options.

Contribute

Please and thank you :)

# Init:
git clone https://github.com/hakanu/pervane.git && cd pervane

# Set up local env.
virtualenv -p python3 env
source env/bin/activate
pip install -r requirements.txt

# Run
python3 pervane/serve.py --debug=true