scriptcraft-python


Namescriptcraft-python JSON
Version 1.6.3 PyPI version JSON
download
home_pageNone
SummaryData processing and quality control tools for research workflows
upload_time2025-09-08 17:36:02
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords data-processing quality-control research validation automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ScriptCraft Python Package

A comprehensive Python package for data processing and quality control tools designed for research workflows, particularly in the field of Huntington's Disease research.

## 🚀 Features

- **Data Processing Tools**: Automated data cleaning, validation, and transformation
- **Quality Control**: Comprehensive validation frameworks with plugin support
- **Research Workflows**: Specialized tools for clinical and biomarker data
- **Release Management**: Automated PyPI and Git release workflows
- **Pipeline Orchestration**: Multi-step workflow automation
- **Extensible Architecture**: Plugin-based system for custom validations
- **Cross-Platform**: Works on Windows, macOS, and Linux

## 📦 Installation

```bash
pip install scriptcraft
```

## 🛠️ Quick Start

### Basic Usage

```python
import scriptcraft
import scriptcraft.common as cu

# Use common utilities
data = cu.load_data("your_data.csv")
cu.log_and_print("✅ Data loaded successfully")
```

### Using Tools

```python
# Import tools directly
from scriptcraft.tools.automated_labeler import AutomatedLabeler
from scriptcraft.tools.data_content_comparer import DataContentComparer

# Create and use tools
labeler = AutomatedLabeler()
comparer = DataContentComparer()

# Run tools with arguments
labeler.run(
    input_paths=["data.csv"],
    output_dir="output",
    mode="labeling"
)
```

### CLI Usage

```bash
# List available tools and pipelines
scriptcraft list

# Run specific tools
scriptcraft rhq_form_autofiller
scriptcraft data_content_comparer

# Run pipelines
scriptcraft data_quality
scriptcraft dictionary_pipeline

# Use release management CLI
scriptcraft-release pypi-test
scriptcraft-release git-sync
scriptcraft-release full-release

# Use release manager directly (RECOMMENDED for version bumps)
python -c "from scriptcraft.tools.release_manager import ReleaseManager; ReleaseManager().run(mode='python_package', version_type='patch', auto_push=True)"

# Run specific tools via console scripts
rhq-autofiller --help
data-comparer --help
auto-labeler --help
function-auditor --help

# Or run tools directly
python -m scriptcraft.tools.rhq_form_autofiller --help
python -m scriptcraft.tools.data_content_comparer --help
```

## 🧰 Available Tools

### Data Processing
- **AutomatedLabeler**: Automated data labeling and classification
- **DataContentComparer**: Compare datasets for consistency
- **SchemaDetector**: Automatic schema detection and validation
- **DateFormatStandardizer**: Standardize date formats across datasets
- **DictionaryCleaner**: Clean and validate dictionary files

### Quality Control
- **DictionaryDrivenChecker**: Validation using predefined dictionaries
- **DictionaryValidator**: Validate dictionary structures
- **MedVisitIntegrityValidator**: Validate medical visit data integrity
- **ScoreTotalsChecker**: Validate score calculations
- **FeatureChangeChecker**: Detect changes in data features

### Automation
- **RHQFormAutofiller**: Automated form filling for research questionnaires
- **DictionaryWorkflow**: Complete dictionary processing workflows

### Release Management
- **PyPIReleaseTool**: Automated PyPI package testing and release
- **GitWorkspaceTool**: Git repository management and operations
- **GitSubmoduleTool**: Git submodule synchronization and management
- **GenericReleaseTool**: Flexible release workflow orchestration

## 🔧 Development

### Installation for Development

```bash
# Clone the repository
git clone https://github.com/yourusername/scriptcraft-python.git
cd scriptcraft-python

# Install in development mode
pip install -e .
```

### Running Tests

```bash
# Run all tests
python -m pytest

# Run specific test categories
python -m pytest tests/unit/
python -m pytest tests/integration/
```

## 📚 Documentation

For comprehensive documentation, examples, and advanced usage:

- **Main Documentation**: [ScriptCraft Workspace](https://github.com/yourusername/ScriptCraft-Workspace)
- **Tool Documentation**: See individual tool README files
- **API Reference**: Available in the main workspace documentation

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guidelines](https://github.com/yourusername/ScriptCraft-Workspace/blob/main/CONTRIBUTING.md) for details.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🆘 Support

- **Issues**: [GitHub Issues](https://github.com/yourusername/scriptcraft-python/issues)
- **Documentation**: [ScriptCraft Workspace](https://github.com/yourusername/ScriptCraft-Workspace)
- **Email**: scriptcraft@example.com

## 🙏 Acknowledgments

- Built for the Huntington's Disease research community
- Developed with support from research institutions
- Thanks to all contributors and users

---

**ScriptCraft Python Package** - Making research data processing easier, one tool at a time. 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "scriptcraft-python",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "ScriptCraft Team <scriptcraft@example.com>",
    "keywords": "data-processing, quality-control, research, validation, automation",
    "author": null,
    "author_email": "ScriptCraft Team <scriptcraft@example.com>",
    "download_url": "https://files.pythonhosted.org/packages/ad/5b/015af3d42dd49591dbe50625d4ec23caa8f559615bab620be4aa4f6adfe3/scriptcraft_python-1.6.3.tar.gz",
    "platform": null,
    "description": "# ScriptCraft Python Package\r\n\r\nA comprehensive Python package for data processing and quality control tools designed for research workflows, particularly in the field of Huntington's Disease research.\r\n\r\n## \ud83d\ude80 Features\r\n\r\n- **Data Processing Tools**: Automated data cleaning, validation, and transformation\r\n- **Quality Control**: Comprehensive validation frameworks with plugin support\r\n- **Research Workflows**: Specialized tools for clinical and biomarker data\r\n- **Release Management**: Automated PyPI and Git release workflows\r\n- **Pipeline Orchestration**: Multi-step workflow automation\r\n- **Extensible Architecture**: Plugin-based system for custom validations\r\n- **Cross-Platform**: Works on Windows, macOS, and Linux\r\n\r\n## \ud83d\udce6 Installation\r\n\r\n```bash\r\npip install scriptcraft\r\n```\r\n\r\n## \ud83d\udee0\ufe0f Quick Start\r\n\r\n### Basic Usage\r\n\r\n```python\r\nimport scriptcraft\r\nimport scriptcraft.common as cu\r\n\r\n# Use common utilities\r\ndata = cu.load_data(\"your_data.csv\")\r\ncu.log_and_print(\"\u2705 Data loaded successfully\")\r\n```\r\n\r\n### Using Tools\r\n\r\n```python\r\n# Import tools directly\r\nfrom scriptcraft.tools.automated_labeler import AutomatedLabeler\r\nfrom scriptcraft.tools.data_content_comparer import DataContentComparer\r\n\r\n# Create and use tools\r\nlabeler = AutomatedLabeler()\r\ncomparer = DataContentComparer()\r\n\r\n# Run tools with arguments\r\nlabeler.run(\r\n    input_paths=[\"data.csv\"],\r\n    output_dir=\"output\",\r\n    mode=\"labeling\"\r\n)\r\n```\r\n\r\n### CLI Usage\r\n\r\n```bash\r\n# List available tools and pipelines\r\nscriptcraft list\r\n\r\n# Run specific tools\r\nscriptcraft rhq_form_autofiller\r\nscriptcraft data_content_comparer\r\n\r\n# Run pipelines\r\nscriptcraft data_quality\r\nscriptcraft dictionary_pipeline\r\n\r\n# Use release management CLI\r\nscriptcraft-release pypi-test\r\nscriptcraft-release git-sync\r\nscriptcraft-release full-release\r\n\r\n# Use release manager directly (RECOMMENDED for version bumps)\r\npython -c \"from scriptcraft.tools.release_manager import ReleaseManager; ReleaseManager().run(mode='python_package', version_type='patch', auto_push=True)\"\r\n\r\n# Run specific tools via console scripts\r\nrhq-autofiller --help\r\ndata-comparer --help\r\nauto-labeler --help\r\nfunction-auditor --help\r\n\r\n# Or run tools directly\r\npython -m scriptcraft.tools.rhq_form_autofiller --help\r\npython -m scriptcraft.tools.data_content_comparer --help\r\n```\r\n\r\n## \ud83e\uddf0 Available Tools\r\n\r\n### Data Processing\r\n- **AutomatedLabeler**: Automated data labeling and classification\r\n- **DataContentComparer**: Compare datasets for consistency\r\n- **SchemaDetector**: Automatic schema detection and validation\r\n- **DateFormatStandardizer**: Standardize date formats across datasets\r\n- **DictionaryCleaner**: Clean and validate dictionary files\r\n\r\n### Quality Control\r\n- **DictionaryDrivenChecker**: Validation using predefined dictionaries\r\n- **DictionaryValidator**: Validate dictionary structures\r\n- **MedVisitIntegrityValidator**: Validate medical visit data integrity\r\n- **ScoreTotalsChecker**: Validate score calculations\r\n- **FeatureChangeChecker**: Detect changes in data features\r\n\r\n### Automation\r\n- **RHQFormAutofiller**: Automated form filling for research questionnaires\r\n- **DictionaryWorkflow**: Complete dictionary processing workflows\r\n\r\n### Release Management\r\n- **PyPIReleaseTool**: Automated PyPI package testing and release\r\n- **GitWorkspaceTool**: Git repository management and operations\r\n- **GitSubmoduleTool**: Git submodule synchronization and management\r\n- **GenericReleaseTool**: Flexible release workflow orchestration\r\n\r\n## \ud83d\udd27 Development\r\n\r\n### Installation for Development\r\n\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/yourusername/scriptcraft-python.git\r\ncd scriptcraft-python\r\n\r\n# Install in development mode\r\npip install -e .\r\n```\r\n\r\n### Running Tests\r\n\r\n```bash\r\n# Run all tests\r\npython -m pytest\r\n\r\n# Run specific test categories\r\npython -m pytest tests/unit/\r\npython -m pytest tests/integration/\r\n```\r\n\r\n## \ud83d\udcda Documentation\r\n\r\nFor comprehensive documentation, examples, and advanced usage:\r\n\r\n- **Main Documentation**: [ScriptCraft Workspace](https://github.com/yourusername/ScriptCraft-Workspace)\r\n- **Tool Documentation**: See individual tool README files\r\n- **API Reference**: Available in the main workspace documentation\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guidelines](https://github.com/yourusername/ScriptCraft-Workspace/blob/main/CONTRIBUTING.md) for details.\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83c\udd98 Support\r\n\r\n- **Issues**: [GitHub Issues](https://github.com/yourusername/scriptcraft-python/issues)\r\n- **Documentation**: [ScriptCraft Workspace](https://github.com/yourusername/ScriptCraft-Workspace)\r\n- **Email**: scriptcraft@example.com\r\n\r\n## \ud83d\ude4f Acknowledgments\r\n\r\n- Built for the Huntington's Disease research community\r\n- Developed with support from research institutions\r\n- Thanks to all contributors and users\r\n\r\n---\r\n\r\n**ScriptCraft Python Package** - Making research data processing easier, one tool at a time. \r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Data processing and quality control tools for research workflows",
    "version": "1.6.3",
    "project_urls": {
        "Documentation": "https://github.com/mcusac/ScriptCraft-Workspace#readme",
        "Homepage": "https://github.com/mcusac/ScriptCraft-Workspace",
        "Issues": "https://github.com/mcusac/ScriptCraft-Workspace/issues",
        "Repository": "https://github.com/mcusac/ScriptCraft-Workspace"
    },
    "split_keywords": [
        "data-processing",
        " quality-control",
        " research",
        " validation",
        " automation"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "baefb371257bee3da9b7f650e1bacf8104b0c4dcd9bf433df4c594bd7783c1d3",
                "md5": "1683e42376d8cfd816f914de1a9d1f96",
                "sha256": "71697ce43ccde4de185ca6bec2400e1859ebb941d6885fa1301662f844a991e8"
            },
            "downloads": -1,
            "filename": "scriptcraft_python-1.6.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1683e42376d8cfd816f914de1a9d1f96",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 379722,
            "upload_time": "2025-09-08T17:36:00",
            "upload_time_iso_8601": "2025-09-08T17:36:00.735804Z",
            "url": "https://files.pythonhosted.org/packages/ba/ef/b371257bee3da9b7f650e1bacf8104b0c4dcd9bf433df4c594bd7783c1d3/scriptcraft_python-1.6.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ad5b015af3d42dd49591dbe50625d4ec23caa8f559615bab620be4aa4f6adfe3",
                "md5": "5b148c957bf9c0466acf292f06c7b78a",
                "sha256": "6918c5c0b2bea378985114753f15e5bee473f889e00d9048ac3dd8467119ed43"
            },
            "downloads": -1,
            "filename": "scriptcraft_python-1.6.3.tar.gz",
            "has_sig": false,
            "md5_digest": "5b148c957bf9c0466acf292f06c7b78a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 280527,
            "upload_time": "2025-09-08T17:36:02",
            "upload_time_iso_8601": "2025-09-08T17:36:02.106569Z",
            "url": "https://files.pythonhosted.org/packages/ad/5b/015af3d42dd49591dbe50625d4ec23caa8f559615bab620be4aa4f6adfe3/scriptcraft_python-1.6.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-08 17:36:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mcusac",
    "github_project": "ScriptCraft-Workspace#readme",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "scriptcraft-python"
}
        
Elapsed time: 1.32931s