semvec/pypi-packages huggingface dataset:
school 1.3.2
🏫 Basic CLI for school planning.
License: MIT

# school

<div align="center">
    <img src="https://raw.githubusercontent.com/mortim1/school/master/assets/logo.png" />
</div>

Pre-requirements:
* python (> 3)
* pip (with version superior to 3 from python)

## Installation
```
pip install school
```

## Upgrade
```
pip install --upgrade school
```

## Commands

```
school -h           
```

    - create              [Creating agenda.]
    - add                 [Adding new task in agenda.]
    - done                [Removing task in agenda.]
    - serve               [Creating local server for listing all tasks in browser.]
    - restore             [Restoring task in angenda.]

# Summary
- [create](#create)
- [add](#add)
- [done](#done)
- [serve](#serve)
- [restore](#restore)


## Examples

<div id="create">Creating agenda</div>

```
school create (optional: -c or --create [filename])
```
by default filename is "index".

```
school create -c "agenda"
```

```
school create --create "agenda"
```

----------------------------------------------


<div id="add">Adding new task in agenda.</div>

```
school add (optional: -a or --add [filename])
```

```
school add -a "agenda"

Title of task ? Review Lesson
School subject ? Mathematics
Date (format YYYY/MM/DD) ? 2020/03/18
Hour (format HH/MM) ? 16:30
```

----------------------------------------------

<div id="serve">Creating local server for listing all tasks in browser</div>

```
school serve (optional: -n or --name [filename], -p or --port [PORT])
```

```
school serve

Bottle v0.12.18 server starting up (using WSGIRefServer())...
Listening on http://localhost:4000/
Hit Ctrl-C to quit.
```


In your browser, you type this link: ``http://localhost:4000/``

![example1](https://raw.githubusercontent.com/mortim1/school/master/assets/example1.png)

----------------------------------------------

<div id="done">You can get id of task in local server created by: </div>

``school serve``

```
school done [id] (optional: -n or --name [filename]) 
```

```
school done acf06dcb-4f02-47ff-9300-7871c14e803b
```

![example2](https://raw.githubusercontent.com/mortim1/school/master/assets/example2.png)

----------------------------------------------

<div id="restore">Restoring task in agenda</div>

```
school restore [id] (optional: -rn or --restore_name [filename]) 
```

```
school restore acf06dcb-4f02-47ff-9300-7871c14e803b
```

If your are late for complishing task, there will this message.
![example3](https://raw.githubusercontent.com/mortim1/school/master/assets/example3.png)