Skip to content

Commit

Permalink
A bit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pylover committed Jan 21, 2020
1 parent 6189896 commit 04790a1
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,69 @@

Store, Update and get JSON document using URL.


### Install

It's highly recommended to use virtualenv to install the fittonia. my favorite
virtualenv toolbox is [virtualenvwrapper](https://pypi.org/project/virtualenvwrapper/).

So, the `workon` command on this page is related to the `virtualenvwrapper`
package and you may use your favorite virtualenv utility such as python's
builtin.

First install required system packages:

```bash
sudo apt install libpq-dev postgresql python3-dev
```

Then install the fittonia:

```bash
git clone https://github.com/pylover/fittonia.git
cd fittonia
pip install [-e] .
```

Or

```bash
pip install git+https://github.com/pylover/fittonia.git
```


### Usage

#### CLI

#### Bash Autocompletion

```bash
fittonia completion install
```


#### Help?

Use the `-h/--help` to discover all command line features.

```bash
fittonia --help
fittonia db --help
fittonia jwt --help
```


Deactivate and activate your virtual environment to use bash auto completion.

```bash
deactivate && workon <virtualenv>
```

#### Create database

```bash
fittonia db create [-p [postgres-password]]
```

0 comments on commit 04790a1

Please sign in to comment.