mirror of
https://github.com/fastapi/sqlmodel.git
synced 2025-11-01 02:43:22 +08:00
40 lines
2.2 KiB
Markdown
40 lines
2.2 KiB
Markdown
# Install **SQLModel**
|
|
|
|
Create a project directory, create a [virtual environment](virtual-environments.md){.internal-link target=_blank}, activate it, and then install **SQLModel**, for example with:
|
|
|
|
<div class="termy">
|
|
|
|
```console
|
|
$ pip install sqlmodel
|
|
---> 100%
|
|
Successfully installed sqlmodel pydantic sqlalchemy
|
|
```
|
|
|
|
</div>
|
|
|
|
As **SQLModel** is built on top of <a href="https://www.sqlalchemy.org/" class="external-link" target="_blank">SQLAlchemy</a> and <a href="https://pydantic-docs.helpmanual.io/" class="external-link" target="_blank">Pydantic</a>, when you install `sqlmodel` they will also be automatically installed.
|
|
|
|
## Install DB Browser for SQLite
|
|
|
|
Remember that [SQLite is a simple database in a single file](databases.md#a-single-file-database){.internal-link target=_blank}?
|
|
|
|
For most of the tutorial I'll use SQLite for the examples.
|
|
|
|
Python has integrated support for SQLite, it is a single file read and processed from Python. And it doesn't need an [External Database Server](databases.md#a-server-database){.internal-link target=_blank}, so it will be perfect for learning.
|
|
|
|
In fact, SQLite is perfectly capable of handling quite big applications. At some point you might want to migrate to a server-based database like <a href="https://www.postgresql.org/" class="external-link" target="_blank">PostgreSQL</a> (which is also free). But for now we'll stick to SQLite.
|
|
|
|
Through the tutorial I will show you SQL fragments, and Python examples. And I hope (and expect 🧐) you to actually run them, and verify that the database is working as expected and showing you the same data.
|
|
|
|
To be able to explore the SQLite file yourself, independent of Python code (and probably at the same time), I recommend you use <a href="https://sqlitebrowser.org/" class="external-link" target="_blank">DB Browser for SQLite</a>.
|
|
|
|
It's a great and simple program to interact with SQLite databases (SQLite files) in a nice user interface.
|
|
|
|
<img src="https://sqlitebrowser.org/images/screenshot.png">
|
|
|
|
Go ahead and <a href="https://sqlitebrowser.org/" class="external-link" target="_blank">Install DB Browser for SQLite</a>, it's free.
|
|
|
|
## Next Steps
|
|
|
|
Okay, let's get going! On the next section we'll start the [Tutorial - User Guide](tutorial/index.md). 🚀
|