| Name | mind-metrics JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Workplace Mental Health Analytics - A comprehensive data analysis application for mental health survey data |
| upload_time | 2025-07-12 05:56:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | # MIT License
Copyright (c) 2025 Mind Metrics Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
burnout-analysis
data-visualization
employee-wellbeing
mental-health
statistics
workplace-analytics
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Mind Metrics
**Mind Metrics** is a comprehensive data analysis application for workplace mental health survey data. It provides insights into burnout patterns, stress factors, and workplace well-being metrics through interactive visualizations and statistical analysis.
## Features
- 📊 **Comprehensive Analytics**: Analyze burnout levels, job satisfaction, stress patterns, and productivity metrics
- 📈 **Interactive Visualizations**: Generate insightful plots and charts for mental health data
- 🔧 **Flexible Data Input**: Support for CSV and Excel files with automatic data validation
- 🖥️ **Command Line Interface**: Easy-to-use CLI built with Click framework
- 📋 **Detailed Reporting**: Generate comprehensive reports on workplace mental health trends
- 🧪 **Robust Testing**: Comprehensive test suite ensuring data integrity and reliability
## Installation
### From PyPI (Recommended)
```bash
pip install mind-metrics
```
### From Source
```bash
git clone https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7.git
cd group-7
pip install uv
uv sync
uv pip install -e .
```
## Quick Start
### Basic Usage
```bash
# Analyze a mental health dataset
mind-metrics --source dataset/mental_health_workplace_survey.csv
# Run in text-only mode (no GUI plots)
mind-metrics --source dataset/mental_health_workplace_survey.csv --text-only
# Enable verbose logging
mind-metrics --source dataset/mental_health_workplace_survey.csv -vv
# Get help
mind-metrics --help
```
### Example Analysis
```bash
# Comprehensive analysis with debug output
mind-metrics --source https://example.com/survey.csv -vvv --text-only
```
## Data Format
Mind Metrics expects datasets with the following key columns:
- **EmployeeID**: Unique identifier for employees
- **Age**: Employee age
- **Gender**: Employee gender
- **BurnoutLevel**: Burnout score (0-10 scale)
- **JobSatisfaction**: Job satisfaction score (0-10 scale)
- **StressLevel**: Stress level (0-10 scale)
- **WorkLifeBalanceScore**: Work-life balance rating
- **HasMentalHealthSupport**: Whether employee has mental health support
For a complete list of supported columns, see our [data schema documentation](docs/data-schema.md).
## Example Dataset
Mind Metrics includes an example dataset (`mental_health_workplace_survey.csv`) for testing and demonstration purposes. This dataset is based on the "Mental Health and Burnout in the Workplace" dataset by Khushi Yadav, available on [Kaggle](https://www.kaggle.com/datasets/khushikyad001/mental-health-and-burnout-in-the-workplace).
### Dataset Attribution
The example dataset used in this project is derived from:
- **Title**: Mental Health and Burnout in the Workplace
- **Author**: Khushi Yadav
- **Source**: Kaggle
- **URL**: https://www.kaggle.com/datasets/khushikyad001/mental-health-and-burnout-in-the-workplace
- **License**: [MIT License](https://www.mit.edu/~amini/LICENSE.md)
We thank the original dataset creator for making this valuable data available for research and development purposes.
## Command Line Options
```
Options:
--source TEXT URL or path to dataset (CSV/Excel) [required]
-v, -vv, -vvv Verbose output (WARNING/INFO/DEBUG levels)
--text-only Suppress graphical output
--output-dir TEXT Directory for output files [default: ./output]
--format [json|csv] Output format for reports [default: json]
--help Show this message and exit.
```
## Output
Mind Metrics generates several types of output:
1. **Summary Statistics**: Key metrics and trends in your data
2. **Visualizations**: Charts showing burnout patterns, correlations, and distributions
3. **Reports**: Detailed analysis reports in JSON or CSV format
4. **Recommendations**: Data-driven insights for improving workplace mental health
## Development
### Setting up Development Environment
```bash
# Clone the repository
git clone https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7.git
cd group-7
# Install dependencies
uv sync
# Install pre-commit hooks
pre-commit install
# Run tests
uv run pytest
# Run linting
uv run ruff check mind_metrics/ tests/
uv run mypy mind_metrics/
```
### Project Structure
```
group-7/
├── CITATION.cff
├── CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── dataset/
│ ├── mental_health_workplace_survey.csv
├── pyproject.toml
├── README.md
├── mind_metrics/
│ ├── __init__.py
│ ├── __main__.py # Main entry point
│ ├── cli.py # Command line interface
│ ├── data/
│ │ ├── __init__.py
│ │ ├── loader.py # Data loading and validation
│ │ └── cleaner.py # Data cleaning utilities
│ ├── analysis/
│ │ ├── __init__.py
│ │ ├── burnout.py # Burnout analysis
│ │ ├── correlations.py # Correlation analysis
│ │ └── statistics.py # Statistical computations
│ ├── visualization/
│ │ ├── __init__.py
│ │ ├── plots.py # Plotting functions
│ │ └── dashboard.py # Dashboard generation
│ └── utils/
│ ├── __init__.py
│ ├── logger.py # Logging configuration
│ └── validation.py # Data validation utilities
├── tests/
│ ├── conftest.py
│ ├── integration/
│ │ ├── test_cli.py
│ │ └── test_end_to_end.py
│ └── unit/
│ ├── test_burnout_analyzer.py
│ ├── test_data_cleaner.py
│ ├── test_data_loader.py
│ └── test_validation.py
└── uv.lock
```
### Running Tests
```bash
# Run all tests
uv run pytest
# Run with coverage
uv run pytest --cov=mind_metrics
# Run specific test file
uv run pytest tests/test_data_loader.py
```
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to get started.
### Development Workflow
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Add tests for your changes
5. Run the test suite
6. Commit your changes (`git commit -m 'feat: add amazing feature'`)
7. Push to the branch (`git push origin feature/amazing-feature`)
8. Open a Merge Request
## Documentation
- [User Guide](https://group-7-589e0e.pages.hzdr.de/)
- [Developer Guide](https://group-7-589e0e.pages.hzdr.de/)
## Citation
If you use Mind Metrics in your research, please cite it:
```bibtex
@software{mind_metrics,
title = {Mind Metrics: Workplace Mental Health Analytics},
author = {Group 7},
year = {2025},
url = {https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7},
version = {1.0.0}
}
```
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
- Mental health research community for inspiration
- Khushi Yadav for the "Mental Health and Burnout in the Workplace" dataset from Kaggle
- Open source contributors and maintainers
- Survey participants who make this research possible
## Support
- 📧 Email: support@mindmetrics.dev
- 🐛 Issues: [GitLab Issues](https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7/-/issues)
- 📖 Documentation: [Project Documentation](https://group-7-589e0e.pages.hzdr.de/)
---
**Made with ❤️ for better workplace mental health**
Raw data
{
"_id": null,
"home_page": null,
"name": "mind-metrics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Lead Developer <lead@mindmetrics.dev>",
"keywords": "burnout-analysis, data-visualization, employee-wellbeing, mental-health, statistics, workplace-analytics",
"author": null,
"author_email": "Mind Metrics Team <team@mindmetrics.dev>",
"download_url": "https://files.pythonhosted.org/packages/93/a9/90ab5204b7a9ad175df7c8570fd7bbfd69a5a5157f210959c6bd3252db5d/mind_metrics-1.0.1.tar.gz",
"platform": null,
"description": "# Mind Metrics\n\n**Mind Metrics** is a comprehensive data analysis application for workplace mental health survey data. It provides insights into burnout patterns, stress factors, and workplace well-being metrics through interactive visualizations and statistical analysis.\n\n## Features\n\n- \ud83d\udcca **Comprehensive Analytics**: Analyze burnout levels, job satisfaction, stress patterns, and productivity metrics\n- \ud83d\udcc8 **Interactive Visualizations**: Generate insightful plots and charts for mental health data\n- \ud83d\udd27 **Flexible Data Input**: Support for CSV and Excel files with automatic data validation\n- \ud83d\udda5\ufe0f **Command Line Interface**: Easy-to-use CLI built with Click framework\n- \ud83d\udccb **Detailed Reporting**: Generate comprehensive reports on workplace mental health trends\n- \ud83e\uddea **Robust Testing**: Comprehensive test suite ensuring data integrity and reliability\n\n## Installation\n\n### From PyPI (Recommended)\n\n```bash\npip install mind-metrics\n```\n\n### From Source\n\n```bash\ngit clone https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7.git\ncd group-7\npip install uv\nuv sync\nuv pip install -e . \n```\n\n## Quick Start\n\n### Basic Usage\n\n```bash\n# Analyze a mental health dataset\nmind-metrics --source dataset/mental_health_workplace_survey.csv\n\n# Run in text-only mode (no GUI plots)\nmind-metrics --source dataset/mental_health_workplace_survey.csv --text-only\n\n# Enable verbose logging\nmind-metrics --source dataset/mental_health_workplace_survey.csv -vv\n\n# Get help\nmind-metrics --help\n```\n\n### Example Analysis\n\n```bash\n# Comprehensive analysis with debug output\nmind-metrics --source https://example.com/survey.csv -vvv --text-only\n```\n\n## Data Format\n\nMind Metrics expects datasets with the following key columns:\n\n- **EmployeeID**: Unique identifier for employees\n- **Age**: Employee age\n- **Gender**: Employee gender\n- **BurnoutLevel**: Burnout score (0-10 scale)\n- **JobSatisfaction**: Job satisfaction score (0-10 scale)\n- **StressLevel**: Stress level (0-10 scale)\n- **WorkLifeBalanceScore**: Work-life balance rating\n- **HasMentalHealthSupport**: Whether employee has mental health support\n\nFor a complete list of supported columns, see our [data schema documentation](docs/data-schema.md).\n\n## Example Dataset\n\nMind Metrics includes an example dataset (`mental_health_workplace_survey.csv`) for testing and demonstration purposes. This dataset is based on the \"Mental Health and Burnout in the Workplace\" dataset by Khushi Yadav, available on [Kaggle](https://www.kaggle.com/datasets/khushikyad001/mental-health-and-burnout-in-the-workplace).\n\n### Dataset Attribution\n\nThe example dataset used in this project is derived from:\n- **Title**: Mental Health and Burnout in the Workplace\n- **Author**: Khushi Yadav\n- **Source**: Kaggle\n- **URL**: https://www.kaggle.com/datasets/khushikyad001/mental-health-and-burnout-in-the-workplace\n- **License**: [MIT License](https://www.mit.edu/~amini/LICENSE.md)\n\nWe thank the original dataset creator for making this valuable data available for research and development purposes.\n\n## Command Line Options\n\n```\nOptions:\n --source TEXT URL or path to dataset (CSV/Excel) [required]\n -v, -vv, -vvv Verbose output (WARNING/INFO/DEBUG levels)\n --text-only Suppress graphical output\n --output-dir TEXT Directory for output files [default: ./output]\n --format [json|csv] Output format for reports [default: json]\n --help Show this message and exit.\n```\n\n## Output\n\nMind Metrics generates several types of output:\n\n1. **Summary Statistics**: Key metrics and trends in your data\n2. **Visualizations**: Charts showing burnout patterns, correlations, and distributions\n3. **Reports**: Detailed analysis reports in JSON or CSV format\n4. **Recommendations**: Data-driven insights for improving workplace mental health\n\n## Development\n\n### Setting up Development Environment\n\n```bash\n# Clone the repository\ngit clone https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7.git\ncd group-7\n\n# Install dependencies\nuv sync\n\n# Install pre-commit hooks\npre-commit install\n\n# Run tests\nuv run pytest\n\n# Run linting\nuv run ruff check mind_metrics/ tests/\nuv run mypy mind_metrics/\n```\n\n### Project Structure\n\n```\ngroup-7/\n\u251c\u2500\u2500 CITATION.cff\n\u251c\u2500\u2500 CONDUCT.md\n\u251c\u2500\u2500 CONTRIBUTING.md\n\u251c\u2500\u2500 LICENSE.md\n\u251c\u2500\u2500 dataset/\n\u2502 \u251c\u2500\u2500 mental_health_workplace_survey.csv\n\u251c\u2500\u2500 pyproject.toml\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 mind_metrics/\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u251c\u2500\u2500 __main__.py # Main entry point\n\u2502 \u251c\u2500\u2500 cli.py # Command line interface\n\u2502 \u251c\u2500\u2500 data/\n\u2502 \u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2502 \u251c\u2500\u2500 loader.py # Data loading and validation\n\u2502 \u2502 \u2514\u2500\u2500 cleaner.py # Data cleaning utilities\n\u2502 \u251c\u2500\u2500 analysis/\n\u2502 \u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2502 \u251c\u2500\u2500 burnout.py # Burnout analysis\n\u2502 \u2502 \u251c\u2500\u2500 correlations.py # Correlation analysis\n\u2502 \u2502 \u2514\u2500\u2500 statistics.py # Statistical computations\n\u2502 \u251c\u2500\u2500 visualization/\n\u2502 \u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2502 \u251c\u2500\u2500 plots.py # Plotting functions\n\u2502 \u2502 \u2514\u2500\u2500 dashboard.py # Dashboard generation\n\u2502 \u2514\u2500\u2500 utils/\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u251c\u2500\u2500 logger.py # Logging configuration\n\u2502 \u2514\u2500\u2500 validation.py # Data validation utilities\n\u251c\u2500\u2500 tests/\n\u2502 \u251c\u2500\u2500 conftest.py\n\u2502 \u251c\u2500\u2500 integration/\n\u2502 \u2502 \u251c\u2500\u2500 test_cli.py\n\u2502 \u2502 \u2514\u2500\u2500 test_end_to_end.py\n\u2502 \u2514\u2500\u2500 unit/\n\u2502 \u251c\u2500\u2500 test_burnout_analyzer.py\n\u2502 \u251c\u2500\u2500 test_data_cleaner.py\n\u2502 \u251c\u2500\u2500 test_data_loader.py\n\u2502 \u2514\u2500\u2500 test_validation.py\n\u2514\u2500\u2500 uv.lock\n```\n\n### Running Tests\n\n```bash\n# Run all tests\nuv run pytest\n\n# Run with coverage\nuv run pytest --cov=mind_metrics\n\n# Run specific test file\nuv run pytest tests/test_data_loader.py\n```\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to get started.\n\n### Development Workflow\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Make your changes\n4. Add tests for your changes\n5. Run the test suite\n6. Commit your changes (`git commit -m 'feat: add amazing feature'`)\n7. Push to the branch (`git push origin feature/amazing-feature`)\n8. Open a Merge Request\n\n## Documentation\n\n- [User Guide](https://group-7-589e0e.pages.hzdr.de/)\n- [Developer Guide](https://group-7-589e0e.pages.hzdr.de/)\n\n## Citation\n\nIf you use Mind Metrics in your research, please cite it:\n\n```bibtex\n@software{mind_metrics,\n title = {Mind Metrics: Workplace Mental Health Analytics},\n author = {Group 7},\n year = {2025},\n url = {https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7},\n version = {1.0.0}\n}\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n\n## Acknowledgments\n\n- Mental health research community for inspiration\n- Khushi Yadav for the \"Mental Health and Burnout in the Workplace\" dataset from Kaggle\n- Open source contributors and maintainers\n- Survey participants who make this research possible\n\n## Support\n\n- \ud83d\udce7 Email: support@mindmetrics.dev\n- \ud83d\udc1b Issues: [GitLab Issues](https://codebase.helmholtz.cloud/tud-rse-pojects-2025/group-7/-/issues)\n- \ud83d\udcd6 Documentation: [Project Documentation](https://group-7-589e0e.pages.hzdr.de/)\n\n---\n\n**Made with \u2764\ufe0f for better workplace mental health**",
"bugtrack_url": null,
"license": "# MIT License\n \n Copyright (c) 2025 Mind Metrics Team\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Workplace Mental Health Analytics - A comprehensive data analysis application for mental health survey data",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://gitlab.com/your-team/mind-metrics/-/issues",
"Changelog": "https://gitlab.com/your-team/mind-metrics/-/blob/main/CHANGELOG.md",
"Documentation": "https://your-team.gitlab.io/mind-metrics/",
"PyPI": "https://test.pypi.org/project/mind-metrics/",
"Repository": "https://gitlab.com/your-team/mind-metrics"
},
"split_keywords": [
"burnout-analysis",
" data-visualization",
" employee-wellbeing",
" mental-health",
" statistics",
" workplace-analytics"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dd39e9586b03b686c3c0f3e994b9c83f597a024ca0ab1c60d3230aa25242ae0f",
"md5": "48a100b7a0b7ca4a2583d816740f0e20",
"sha256": "ac3b462c8c1b68d6c67dfb7976d6e2679d3f9de6e94da086b25599d9187dc4b9"
},
"downloads": -1,
"filename": "mind_metrics-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48a100b7a0b7ca4a2583d816740f0e20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 44151,
"upload_time": "2025-07-12T05:56:00",
"upload_time_iso_8601": "2025-07-12T05:56:00.817731Z",
"url": "https://files.pythonhosted.org/packages/dd/39/e9586b03b686c3c0f3e994b9c83f597a024ca0ab1c60d3230aa25242ae0f/mind_metrics-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "93a990ab5204b7a9ad175df7c8570fd7bbfd69a5a5157f210959c6bd3252db5d",
"md5": "c1d72aab29bd1552d0f51a15d326b3c0",
"sha256": "81fc8d9cf788a7488c8a03e7544fca7ccd08f7d4f7f1b94610b6c2d59aaaf9d6"
},
"downloads": -1,
"filename": "mind_metrics-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c1d72aab29bd1552d0f51a15d326b3c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 58235,
"upload_time": "2025-07-12T05:56:02",
"upload_time_iso_8601": "2025-07-12T05:56:02.368767Z",
"url": "https://files.pythonhosted.org/packages/93/a9/90ab5204b7a9ad175df7c8570fd7bbfd69a5a5157f210959c6bd3252db5d/mind_metrics-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 05:56:02",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "your-team",
"gitlab_project": "mind-metrics",
"lcname": "mind-metrics"
}
