CLI

This comprehensive guide aims to provide you with all the necessary information to effectively utilize the command-line interface (CLI) tools offered by petisco. Whether you are a beginner or an experienced developer, this documentation will help you harness the full potential of our CLI tools and streamline your development process.

You can check installed version of petisco with:

$ petisco --version
petisco 🍪 => 2.X.X

Or generate a random UUID v4 with:

$ petisco --uuid
a4161d89-9819-4730-99e3-7d2890fb17bc

And also print the current utcnow:

$ petisco --utcnow
2023-05-22 13:49:13.243518

`petisco-dev`¶

Provides various commands to help you interact with and manage your petisco-based application.

This is what petisco-dev provides us:

$ petisco-dev --help
petisco dev tools to inspect your application

options:
  -h, --help            show this help message and exit
  -i, --info            show petisco app info.
  -deps, --dependencies
                        show petisco app dependencies.
  -configs, --configurers
                        show petisco app configurers.
  -sql-models, --sql-models
                        show petisco sql models.
  -declarative-base DECLARATIVE_BASE, --declarative-base DECLARATIVE_BASE
                        path to DeclarativeBase, a class to gather all the SQL models
  --application APPLICATION
                        Module path (default app.application)

Info

If rich package is installed, information will use it to show valuable information in a fancy way.

Show info¶

$ petisco-dev --info
╭────────── Petisco Application ───────────╮
│ name:          my-petisco-app            │
│ version:       1.0.1                     │
│ organization:  alice                     │
│ deployed_at:   2023-05-16 10:41:39       │
│ dependencies:  1                         │
│ configurers:   2                         │
╰──────────────────────────────────────────╯

Show dependencies¶

$ petisco-dev --dependencies
┏━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃      Type┃Default      ┃Implementation      ┃ENV            ┃
┡━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│Repository│SqlRepository│fake: FakeRepository│REPOSITORY_TYPE│
└──────────┴─────────────┴────────────────────┴───────────────┘

Show configurers¶

$ petisco-dev --configurers
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃                Configurer ┃ execute_after_dependencies ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│     PersistenceConfigurer │           False            │
│ RabbitMqMessageConfigurer │            True            │
└───────────────────────────┴────────────────────────────┘

Help

This information is obtained from instantiating a petisco.Application.

By default, petisco-dev searches this application in the module app.application:

app/application.py

from petisco.extra.fastapi import FastApiApplication

from app import (
    APPLICATION_LATEST_DEPLOY,
    APPLICATION_NAME,
    APPLICATION_VERSION,
    ORGANIZATION,
)
from app.fastapi import fastapi_configurer
from app.petisco.configurers.configurers import configurers
from app.petisco.dependencies.dependencies_provider import dependencies_provider

application = FastApiApplication(
    name=APPLICATION_NAME,
    version=APPLICATION_VERSION,
    organization=ORGANIZATION,
    deployed_at=APPLICATION_LATEST_DEPLOY,
    dependencies_provider=dependencies_provider,
    configurers=configurers,
    fastapi_configurer=fastapi_configurer,
)

If your application is defined in other file, you can modify it with petisco-dev --info --application app.other.module.application.

Show SQL Models¶

To show SQL models inheriting from petisco.extra.sqlalchemy.SqlBase use the following command:

$ petisco-dev --sql-models
┏━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃       Model ┃ Filename                                     ┃
┡━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│     SqlUser │ app/src/infrastructure/models/sql_user.py    │
│   SqlClient │ app/src/infrastructure/models/sql_client.py  │
└─────────────┴──────────────────────────────────────────────┘

If you want to specify your own implementation of your DeclarativeBase just pass the path to your extension

$ petisco-dev --sql-models --declarative-base app.models.extended_declarative_base.ExtendedDeclarativeBase
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃         Model ┃ Filename                                     ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│     OtherUser │ app/models/other_user.py                     │
└───────────────┴──────────────────────────────────────────────┘

CLI

petisco-dev¶