PyRetailScience
⚡ Democratizing retail data analytics for all retailers ⚡
🤔 What is PyRetailScience?
pyretailscience is a Python package designed for performing analytics on retail data. Additionally, the package includes functionality for generating test data to facilitate testing and development.
Installation
To install pyretailscience, use the following pip command:
pip install pyretailscience
Quick Start
Generating Simulated Data
The pyretailscience package provides a command-line interface for generating simulated transaction data.
Usage
pyretailscience --config_file=<config_file_path> [--verbose=<True|False>] [--seed=<seed_number>] [output]
Options and Arguments
--config_file=<config_file_path>: The path to the configuration file for the simulation. This is a required argument.--verbose=<True|False>: Optional. Set toTrueto see debug messages. Default isFalse.--seed=<seed_number>: Optional. Seed for the random number generator used in the simulation. If not provided, a random seed will be used.[output]: Optional. The path where the generated transactions will be saved in parquet format. If not provided, the transactions will be saved in the current directory.
Examples
# Get the default transaction config file
wget https://raw.githubusercontent.com/Data-Simply/pyretailscience/0.3.0/data/default_data_config.yaml
# Generate the data file
pyretailscience --config_file=default_data_config.yaml --seed=123 transactions.parquet
This command will generate a file named transactions.parquet with the simulated transaction data, using the configuration file at default data configuration file, and a seed of 123 for the random number generator.
Contributing
We welcome contributions from the community to enhance and improve pyretailscience. To contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with clear messages.
- Push your changes to your fork.
- Open a pull request to the main repository's
mainbranch.
Please make sure to follow the existing coding style and provide unit tests for new features.
Contributors
Made with contrib.rocks.
License
This project is licensed under the Elastic License 2.0 - see the LICENSE file for details.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyretailscience-0.3.0.tar.gz.
File metadata
- Download URL: pyretailscience-0.3.0.tar.gz
- Upload date:
- Size: 22.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
240f2f4c5fe12baa6c84ada87899c18c60cb9c00424e5418c2ecca2c94049e47
|
|
| MD5 |
87e05f8f78fce619ec8ac22d9c2998d8
|
|
| BLAKE2b-256 |
14c4704707cee14e4bad4031e54ecf2137812188d631006d9a7f29c7416dd88f
|
File details
Details for the file pyretailscience-0.3.0-py3-none-any.whl.
File metadata
- Download URL: pyretailscience-0.3.0-py3-none-any.whl
- Upload date:
- Size: 25.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2190f81c317a49e8fbf82471a4faf1d1c530df6cc0b4372c98fb238dafea6e57
|
|
| MD5 |
971713aa2814553ed7581fb9b07b4371
|
|
| BLAKE2b-256 |
afa432bbcb7fc235eaeedcc112760d3676a171853aa658699f49eee5e976d68b
|
