File: install.md

package info (click to toggle)
ormar 0.21.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856 kB
  • sloc: python: 23,666; makefile: 34; sh: 14
file content (68 lines) | stat: -rw-r--r-- 1,193 bytes parent folder | download
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
## Installation

Installation is as simple as:

```py
pip install ormar
```

### Dependencies

Ormar uses `databases` for connectivity issues, `pydantic` for validation and `sqlalchemy-core` for queries.

All three should install along the installation of ormar if not present at your system before.

*  databases
*  pydantic
*  sqlalchemy 

The required versions are pinned in the pyproject.toml file.

## Optional dependencies

*ormar* has three optional dependencies based on database backend you use:

### Database backend

#### Postgresql

```py
pip install ormar[postgresql]
```
Will install also `asyncpg` and `psycopg2`.

#### Mysql

```py
pip install ormar[mysql]
```

Will install also `aiomysql` and `pymysql`.

#### Sqlite

```py
pip install ormar[sqlite]
```

Will install also `aiosqlite`.

### Orjson

```py
pip install ormar[orjson]
```

Will install also `orjson` that is much faster than builtin json parser.

### Crypto

```py
pip install ormar[crypto]
```

Will install also `cryptography` that is required to work with encrypted columns.

### Manual installation of dependencies

Of course, you can also install these requirements manually with `pip install asyncpg` etc.