semvec/pypi-packages huggingface dataset:
dwiki 0.0.3
A simple python wiki
Requires Python: >=3.8
Keywords: wiki python markdown jinja2 cherrypy flask

## A simple python wiki written by David

### Editors

dwiki does not have a complex permissions model. Everything page is public.
The only permission you can grant is the permission to edit pages.

Wiki editors are stored in _users.json as a JSON dictionary.

    {
        "admin": {
            "name": "Administrator",
            "nonce": "some hex random data",
            "password": "hex representation of hmac-sha256 of password"
        }
    }
    
Use the command line to create editors.

    python -m dwiki --adduser
    
### Configuration

Configuration overrides are stored in _config.py as Python code.

The default values, which can be overridden, are:

    TEMPLATES_AUTO_RELOAD=True
    SEND_FILE_MAX_AGE_DEFAULT=300
    SECRET_KEY='development'
    SERVER_ENGINE_AUTORELOAD_ON=False
    SERVER_LOG_SCREEN=True
    SERVER_SOCKET_HOST='0.0.0.0'
    SERVER_SOCKET_PORT=5000
    WIKI_PATH='wiki'
    
You should at least set a unique SECRET_KEY for an internet facing wiki.

### Starting the wiki

    python -m dwiki --start
    
The wiki is served from the WIKI_PATH folder under where the wiki is started.
    
### Page structure

Each page is stored in a folder.
Inside the folder is a file called _settings.json which contains
the title and caption of the page.

    {
        "title": "Welcome to the Wiki",
        "caption": "A place to write what you want"
    }
    
Each section is stored in a file like _section_01.md, _section_02.md etc.

Python code is stored in a file called _page.py
and is executed when the page is loaded and provided as context to
the page render engine.

If a file or folder starts with an underscore (_) then it cannot be served
from the wiki. These are considered to be hidden files.

### Markdown flavour

The [python markdown](https://python-markdown.github.io/extensions/#extensions)
package is used with the following extensions:

* codehilite
* toc
* meta
* wikilinks
* tables (a customised version)

#### Markdown tables

The usual tables markdown extension has been customised to accept meta customisations.

Define a table_class meta at the top of the page to add a class to generated tables.
You can specify table_class more than once to add multiple classes to the table.

### Section types

A section can either be markdown, html, or csv.

Markdown sections are parsed by the Jinja2 render engine first as a template.
Markdown sections are then parsed by the markdown render engine.

CSV sections are rendered using a CSV Jinja2 template.

HTML sections are rendered as a Jinja2 template.
itng 0.1.5
Institute for Advanced Studies in Basic Sciences (IASBS) theoretical neuroscience group toolbox.
Requires Python: >=3.1

### This is ITNG toolbox package.
-  IASBS Theoretical Neuroscience Group toolbox, to analysis the time series, spike trains and graphs in python.

#### Please look at the [documentation](https://github.com/itng/itng_toolbox/blob/master/itng/doc/build/latex/itngtoolbox.pdf).

### installation

#### from pip
```sh
pip3 install itng
```

#### from source code
```sh
sudo python3 setup.py install
```

-  to update the documentation:

```sh
cd itng/doc 
make html       # for html files
make latexpdf   # for pdf file
```
-  to run the test
```sh
cd itng/tests/
python3 test*.py
```

### How to contribute
#### Step 1: Set up a working copy on your computer

```sh
git clone git@github.com:itng/itng_toolbox.git
git remote add origin2 git@github.com:YOUR_USERNAME/itng_toolbox.git
git remote -v
```
#### Step 2: Do some work and push changes

```sh
git checkout -b new_branch_name
git add [files added or changed]
git commit -m "message to commit"
git push origin2 new_branch_name
```
then go to the repository and click on the green button **pull request**.