itemsdb/README.md
2024-09-15 22:49:23 +02:00

64 lines
1.4 KiB
Markdown

# Items database
An approach to implement a cmdb on steroids as a bunch of linked objects.
It's about object schemas, types and typed links to describe the world as
dependency graph.
For further information see the [Items database
documentation](https://code.matthiess.it/collaboration/itemsdb-doc).
## Requirements
* Python3 >= 3.9
* python packages
* pip
* pipenv
* [See pipenv install inctructions](https://pipenv.pypa.io/en/latest/installation.html#make-sure-you-have-python-and-pip)
* sqlite3
* git
* Access to the project git repository
## Install Python requirements
* The required python packages will be installed with the `pipenv` command.
* Install this python package with your native os package installer:
```bash
apt-get install pipenv
```
* Change to the root of your git repository worktree and execute:
```bash
pipenv install
```
This will install all python package dependencies for running this
application.
* To install the development requirements you should execute this command:
```bash
pipenv install --dev
```
* To get an overview of the installed packages and theire depenmmdencies run
"`pipenv graph`"
```bash
pipenv graph
```
## Activate the pipenv environment
Change to the project git repository worktree and execute "`pipenv shell`" to
activate the previously installed python virtual environment.
```bash
pipenv shell
```
This is similar to execute "`. $venv_base_dir/bin/activate`".