Technically, a LIMP package is a Python package. However, what is super to regular Python package, is LIMP package has the following elements:
- Config: Every package in LIMP has to define a
configmethod that returns LIMPConfigmatching dict. More on this in the section Package Config. - Dependencies: LIMP package can define extra
requirements.txtfile including all the package dependencies which then be installed using install dependencies. - Modules: What is more essential to the package than the other two elements is the presence of modules. More on modules in the full API reference of modules.
Since elements #2 and #3 are out of the scope of the doc, the following is only reference to element #1. Config.
Every LIMP package can be given various range of configurations to facilitate faster app setup in any given environment.
Some of the config attrs are available but not supposed to be set using a package config, which are:
The flag of whether debug options are active or not. It's not supposed to be set by a package, rather by the CLI. Default False.
LIMP version as float which the app was developed to be used for. If set, this would trigger a version check at the the launch time. The version should be the version.major number dropping the minor number. default None.
The flag whether test workflow is active or not. If it's active it should be string representing the test name. It's not supposed to be set by a package, rather by the CLI. Default False.
The flag whether test workflow should flush and drop the previous test collections or simply continue with them. It's not supposed to be set by a package, rather by the CLI. Default False.
The flag whether test workflow should break or force testing all steps after first failure. It's not supposed to be set by a package, rather by the CLI. Default False.
These config attrs are still available at public level so that your app can access them for various reasons and scenarios. For instance, your app can check whether debug options are active and print additional verbose messages, or whether test workflow is active and skip sending emails or SMSs as part of the modules methods.
The available configuration options for every package are:
An environment projection object. This can be used to create environment config variables per need. For instance, all the package config attrs can be reused in every env defined in envs. The most essential use-case here is using two set of data_* config attrs set among two envs; dev and prod:
{
'dev':{
'data_server':'mongodb://localhost'
},
'prod':{
'data_server':'mongodb://remotehost'
}
}Such feature allow the developers of the app to develop in their development env and then deploy the app to their prod host, and it would still work without a single change to any of the package or app config. Default {}.
The test workflow tests. Learn more about the workflow and how to make use of the TDD-approach in LIMP in the reference of tests in LIMP. Default {}.
Data driver of choice. It is always set to 'mongodb' by omitting a value due to the fact LIMP currently does not support any other drivers.
Data server to connect to. Usually it's string, however, if you are connecting to MongoDB ReplicaSet with multiple servers you can specify this attr as a list of strings each representing a different server. LIMP would automatically detect this and attempt to connect to the servers one by one until one is connected successfully. Default 'mongodb://localhost'.
Database name to connect to. Default 'limp_data'.
Boolean flag on whether to use secure SSL connection or not. Default False,
Name of the CA certificate to use while connecting to data_server. The certificate would be dynamically created at runtime in certs folder in your app root. This folder is not tracked by LIMP Git repo, which is the reason you don't see it in your cloned repo. Default False.
CA certificate usage flag and body. If it's set, the data connection with data_server would be constructed with this CA file, as data_ca_name. For this, if data_ca is having any truth-matching value, data_ca_name should also be present and valid. In Python, you should paste your certificate as-is including the line breaks. For that you need to make sure you are using the multi-line string. Make sure you don't add any wrong indentations when pasting the certificate body. This config attr was added to support IBM Cloud Databases for MongoDB which requires a CA certificate for connection. Default False.
Microsoft's Azure-specific MongoDB-in-sharded mode (or, database throughput). The problem with databases created under this mode in Azure is the developer need to execute MongoDB command shardCollection to create the collection with assignment of hashed_key at the time of creation. For that, we introduced this config attr that you can set to True to do this on your behalf for all the collections of all the modules of the current loaded app. Default False.
Dict with the attrs of Twilio sid, token, and number values to access their API. Default {}.
Dict with server, username and password of the default email account to send notifications from. Default {}.
Python list of locales used by the package. The form of the locale used in LIMP is lang_COUNTRY. Default ['ar_AE', 'en_AE'].
Default locale of the app. It should be one of the values passed in locales. Default ar_AE.
App-specific locale dictionary. Default {}.
ADMIN username. Default __ADMIN.
ADMIN email. Default ADMIN@LIMP.MASAAR.COM.
ADMIN phone. Default '+971500000000'.
ADMIN password. Default '__ADMIN'.
ANON user session token. Learn more about session tokens in the dedicated section in user and session reference. Default '__ANON_TOKEN_f00000000000000000000012'.
ANON user privileges. These are the privileges that any anonymous user of the app would have. Learn more about privileges from the reference of LIMP privileges. Default {}.
App-specific users groups to create. This is a list of docs, each representing a group. You can specify _id attr in these docs of you want static _id value rather than dynamic. Default [].
DEFAULT group privileges. These are the privileges that all your app users would have. Learn more about privileges from the reference of privileges in LIMP. Default {}.
List of app-specific data indexes to create for data collections. This is an array of all the indexes you want to create for your app to function. For instance, to create a MongoDB $text index on collection staff you can set data_indexes to:
[
{
'collection': 'staff',
'index': [( '$**', 'text' )]
}
]Notice that the name you are passing is the collection name and not the module name. Also, the index attr is the native index format you pass to your MongoDB driver. Default [].
List of app-specific docs to create for the app functionalities. Every list item is a dict with two attrs; module and doc. The docs would be created using LIMP base methods. You can specify _id attr in these docs of you want static _id value rather than dynamic. For instance, to create setting doc in your app you should set docs to:
[
{
'module':'setting',
'doc':{
'_id':ObjectId('f00000000000000000000091'),
'var':'company_name',
'val':{
'ar_AE':'أكمي',
'en_AE':'ACME'
},
'type':'global'
}
}
]Optionally, you can add skip_args with value set to True in the dict to force appending of __ARGS__ to skipped event. This is helpful when you need to force creating a doc with processing its doc attrs. You would get more on the benefits of skip_events attr on LIMP module reference.
Flag to set the app to run in Realm mode. This is an advanced use-case of LIMP that has very specific scenario. Learn more about this mode in the full reference of Realm mode.
App-specific attrs types. This is a dict with pair of key representing the type name and value being a callable that returns boolean based on the passed attr_type and attr values as args to the callable.
In some cases your app can be published to infrastrucure where the data_* config attrs might be dynamic. For this, we added support for env variables to config data_* attrs. If you want to make use of this feature, set any of the data_* config attrs to:
{
'data_*':'__env.ENV_VAR_HERE'
}If LIMPd fails to read the specified env variable, the config attr value would be reverted back to the default value.