No project description provided
Project description
Candore
Introduction
Candore
is the command line interface data integrity tool. The tool is build to verify the change made in a product has any impact on data in product.
The change could be:
- Upgrade of the product to new version
- Some Patch applied to the product
- Developers made code changes locally / upstream etc
- Or any kind of change that we could think of
Verifications that candore supports is:
- Data loss - The major impact that candore cares
- Data Altered - The change in data entity
- Relation between the entities - Verifies if the link is not broken between entities
Installation
$ mkdir ~/candore && cd ~/candore
$ pip install candore
Configuration
The candore
uses the DynaConf
configuration python module to access the data in settings.yaml
, it also allows an unique way of declaring secrets via Environment variables instead of putting in plain settings.yaml
.
e.g: The password field can be set via environment variable by exporting the environment variable
# export CANDORE_CANDORE_PASSWORD = myPa$$worb"
Configuration with PyPi package:
Copy/Download settings.yaml.template
to local ~/candore
directory as settings.yaml
, update it with the details and other configuration details for successful run.
Usage Examples
- candore help:
# candore --help
Usage: candore [OPTIONS] COMMAND [ARGS]...
A data integrity validation CLI tool for products post change
Options:
--version Installed version of candore
-s, --settings-file TEXT Settings file path
-c, --components-file TEXT Components file path
--help Show this message and exit.
Commands:
apis List API lister endpoints from Product
compare Compare pre and post upgrade data
extract Extract and save data using API lister endpoints
reader JSON Reader for reading the specific path data from entities...
There are 3 stages in which candore works:
- Read data from the web server using APIs, before change:
# candore extract -o pre_entities.json --mode pre
This reads all data from web server before the change and saves in the json file in the current directory.
- Read data from the web server using APIs, after change:
# candore extract -o post_entities.json --mode post
This reads all data from web server after the change and saves in the json file in the current directory.
- Use the json data files to compare the data integrity:
# candore compare -t csv -o results.csv --pre pre_entities.json --post post_entities.json
This compares two json datasets and generates the reports of data integrity in CSV format in CSV file.
Reports could be generated in json:
# candore compare -t json -o results.json --pre pre_entities.json --post post_entities.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file candore-1.4.0.tar.gz
.
File metadata
- Download URL: candore-1.4.0.tar.gz
- Upload date:
- Size: 28.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e623f77caee648581b499baa387bf0d34e3a60af20c2fe992e9cc3ccea1021c4 |
|
MD5 | 10f40e34289570a7cfe00762a1926426 |
|
BLAKE2b-256 | e2a9e463bea920ce5df864db4fe7c8d451110a17c045b9eebad03bc0bb927bff |
File details
Details for the file candore-1.4.0-py2.py3-none-any.whl
.
File metadata
- Download URL: candore-1.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 35.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8c4f5a600d5d4d4e753a478977b1cb11ce01e1a6c1cd076df3bc58aa0691cee |
|
MD5 | c9021c93a8d78d2b1145c168cdd488bf |
|
BLAKE2b-256 | bb534b8e9eab807c2ad3beecf075c4f5e21da89f48581c6f7efaa01f417861b7 |