domd 0.1.0__tar.gz

domd-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

domd-0.1.0/PKG-INFO

@@ -0,0 +1,418 @@
+Metadata-Version: 2.3
+Name: domd
+Version: 0.1.0
+Summary: Project Command Detector - Automatically detects and tests project commands, generates TODO.md for failed commands
+License: Apache-2.0
+Author: Tom Sapletta
+Author-email: info@softreck.dev
+Maintainer: WRONAI Team
+Requires-Python: >=3.8.1,<3.14
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Systems Administration
+Provides-Extra: all
+Provides-Extra: cli
+Provides-Extra: colors
+Requires-Dist: click (>=8.1.0,<9.0.0) ; extra == "cli" or extra == "all"
+Requires-Dist: colorama (>=0.4.6,<0.5.0) ; extra == "colors" or extra == "all"
+Requires-Dist: configparser (>=5.3.0,<6.0.0)
+Requires-Dist: pathlib ; python_version >= "3.4"
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: rich (>=13.0.0,<14.0.0) ; extra == "colors" or extra == "all"
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Project-URL: Bug Tracker, https://github.com/wronai/domd/issues
+Project-URL: Changelog, https://github.com/wronai/domd/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://wronai.github.io/domd
+Project-URL: Homepage, https://github.com/wronai/domd
+Project-URL: Repository, https://github.com/wronai/domd.git
+Description-Content-Type: text/markdown
+
+# TodoMD - Project Command Detector
+
+[![PyPI version](https://badge.fury.io/py/domd.svg)](https://badge.fury.io/py/domd)
+[![Python Support](https://img.shields.io/pypi/pyversions/domd.svg)](https://pypi.org/project/domd/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://github.com/yourusername/domd/workflows/Tests/badge.svg)](https://github.com/yourusername/domd/actions)
+
+**TodoMD** automatically detects and tests project commands from various configuration files, then generates a detailed `TODO.md` file for failed commands with error reports and suggested fixes.
+
+## 🚀 Features
+
+- **Universal Detection**: Supports 15+ project types and build systems
+- **Smart Testing**: Executes commands with configurable timeouts and error handling
+- **Detailed Reports**: Generates formatted TODO.md with error analysis and fix suggestions
+- **Multiple Formats**: Output in Markdown, JSON, or plain text
+- **CI/CD Ready**: Perfect for automated project health checks
+- **Zero Configuration**: Works out of the box with sensible defaults
+
+## 📦 Supported Project Types
+
+### JavaScript/Node.js
+- `package.json` - npm scripts
+- `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` - dependency installation
+
+### Python
+- `pyproject.toml` - Poetry scripts, pytest configuration
+- `setup.py` - installation and testing
+- `requirements.txt` - pip installations
+- `tox.ini` - test environments
+- `pytest.ini` - test configuration
+
+### Build Systems
+- `Makefile` - make targets
+- `CMakeLists.txt` - cmake builds
+- `build.gradle` - gradle tasks
+- `pom.xml` - maven goals
+
+### Docker & Containers
+- `Dockerfile` - image builds
+- `docker-compose.yml` - service orchestration
+
+### CI/CD
+- `.github/workflows/*.yml` - GitHub Actions
+- `.gitlab-ci.yml` - GitLab CI
+- `Jenkinsfile` - Jenkins pipelines
+
+### Other Languages
+- `composer.json` (PHP)
+- `Gemfile` (Ruby)
+- `Cargo.toml` (Rust)
+- `go.mod` (Go)
+
+## 🛠 Installation
+
+### Using pip
+```bash
+pip install domd
+```
+
+### Using Poetry
+```bash
+poetry add domd
+```
+
+### From source
+```bash
+git clone https://github.com/yourusername/domd.git
+cd domd
+poetry install
+```
+
+## 📖 Usage
+
+### Basic Usage
+```bash
+# Scan current directory
+domd
+
+# Scan specific project
+domd --path /path/to/project
+
+# Preview commands without executing
+domd --dry-run
+
+# Custom output file
+domd --output FAILED_COMMANDS.md
+```
+
+### Advanced Options
+```bash
+# Verbose output with detailed logging
+domd --verbose
+
+# Quiet mode (errors only)
+domd --quiet
+
+# Custom timeout (default: 60 seconds)
+domd --timeout 120
+
+# Different output formats
+domd --format json
+domd --format text
+
+# Exclude specific patterns
+domd --exclude "*.test.js" --exclude "node_modules/*"
+
+# Include only specific patterns
+domd --include-only "Makefile" --include-only "package.json"
+```
+
+### Example Output
+
+When commands fail, TodoMD generates a structured TODO.md:
+
+```markdown
+# TODO - Failed Project Commands
+
+Automatically generated by TodoMD v0.1.0
+Date: 2025-06-06 10:30:15
+Project: /home/user/my-project
+
+Found **2** commands that require fixing:
+
+## Task 1: NPM script - test
+
+**Source:** `package.json`
+**Return Code:** 1
+
+### Command to fix:
+```bash
+npm run test
+```
+
+### Error:
+```
+Error: Cannot find module 'jest'
+npm ERR! Test failed. See above for more details.
+```
+
+### Suggested Actions:
+- [ ] Install missing dependencies: `npm install`
+- [ ] Check if jest is in devDependencies
+- [ ] Verify test configuration
+- [ ] Run `npm install --save-dev jest` if missing
+
+---
+
+## Task 2: Make target - build
+
+**Source:** `Makefile`
+**Return Code:** 2
+
+### Command to fix:
+```bash
+make build
+```
+
+### Error:
+```
+make: *** No rule to make target 'src/main.c', needed by 'build'. Stop.
+```
+
+### Suggested Actions:
+- [ ] Check if source files exist
+- [ ] Verify Makefile paths and dependencies
+- [ ] Review build configuration
+- [ ] Ensure all required files are present
+```
+
+## 🔧 Configuration
+
+### Command Line Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--path`, `-p` | Project directory path | `.` (current) |
+| `--dry-run`, `-d` | Preview mode (no execution) | `False` |
+| `--verbose`, `-v` | Detailed output | `False` |
+| `--quiet`, `-q` | Suppress output except errors | `False` |
+| `--output`, `-o` | Output file path | `TODO.md` |
+| `--format` | Output format (markdown/json/text) | `markdown` |
+| `--timeout` | Command timeout in seconds | `60` |
+| `--exclude` | Exclude file patterns | `None` |
+| `--include-only` | Include only specific patterns | `None` |
+
+## 🤖 Programmatic Usage
+
+```python
+from domd import ProjectCommandDetector
+
+# Initialize detector
+detector = ProjectCommandDetector(
+    project_path="./my-project",
+    timeout=60,
+    exclude_patterns=["*.pyc", "__pycache__/*"]
+)
+
+# Scan for commands
+commands = detector.scan_project()
+print(f"Found {len(commands)} commands")
+
+# Test commands
+detector.test_commands(commands)
+
+# Generate report
+detector.generate_output_file("RESULTS.md", "markdown")
+
+# Access results
+failed_commands = detector.failed_commands
+success_rate = (len(commands) - len(failed_commands)) / len(commands) * 100
+print(f"Success rate: {success_rate:.1f}%")
+```
+
+## 🧪 Development
+
+### Setup Development Environment
+```bash
+git clone https://github.com/yourusername/domd.git
+cd domd
+poetry install --with dev,docs,testing
+
+# Install pre-commit hooks
+poetry run pre-commit install
+```
+
+### Running Tests
+```bash
+# Run all tests
+poetry run pytest
+
+# Run with coverage
+poetry run pytest --cov=domd --cov-report=html
+
+# Run specific test categories
+poetry run pytest -m "unit"
+poetry run pytest -m "integration"
+```
+
+### Code Quality
+```bash
+# Format code
+poetry run black src/ tests/
+poetry run isort src/ tests/
+
+# Linting
+poetry run flake8 src/ tests/
+poetry run mypy src/
+
+# All quality checks
+make lint
+```
+
+### Building Documentation
+```bash
+# Serve locally
+poetry run mkdocs serve
+
+# Build static site
+poetry run mkdocs build
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Adding New Parsers
+
+To add support for a new project type:
+
+1. Create a parser in `src/domd/parsers/`
+2. Implement the parser interface
+3. Add tests in `tests/parsers/`
+4. Update documentation
+
+Example parser structure:
+```python
+from .base import BaseParser
+
+class NewProjectParser(BaseParser):
+    def can_parse(self, file_path: Path) -> bool:
+        return file_path.name == "config.yaml"
+    
+    def parse_commands(self, file_path: Path) -> List[Dict]:
+        # Implementation here
+        pass
+```
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Inspired by the need for automated project health monitoring
+- Built with [Poetry](https://python-poetry.org/) for dependency management
+- Uses [pytest](https://pytest.org/) for testing framework
+- Documentation powered by [MkDocs](https://www.mkdocs.org/)
+
+## 📊 Project Stats
+
+- **Languages Supported**: 10+
+- **File Types Detected**: 20+
+- **Command Types**: 50+
+- **Python Versions**: 3.8+
+
+## 🔗 Links
+
+- [Documentation](https://domd.readthedocs.io)
+- [PyPI Package](https://pypi.org/project/domd/)
+- [GitHub Repository](https://github.com/yourusername/domd)
+- [Issue Tracker](https://github.com/yourusername/domd/issues)
+- [Changelog](https://github.com/yourusername/domd/blob/main/CHANGELOG.md)
+
+## 💡 Use Cases
+
+- **Pre-deployment Checks**: Verify all project commands work before deployment
+- **CI/CD Integration**: Add as a quality gate in your pipeline
+- **Onboarding**: Help new developers identify setup issues
+- **Project Maintenance**: Regular health checks for legacy projects
+- **Documentation**: Generate comprehensive command documentation
+
+## ⚡ Quick Examples
+
+### CI/CD Integration (GitHub Actions)
+```yaml
+name: Project Health Check
+on: [push, pull_request]
+
+jobs:
+  health-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+    - name: Install TodoMD
+      run: pip install domd
+    - name: Run Project Health Check
+      run: domd --verbose
+    - name: Upload TODO.md if failures
+      if: failure()
+      uses: actions/upload-artifact@v3
+      with:
+        name: failed-commands
+        path: TODO.md
+```
+
+### Make Integration
+```makefile
+.PHONY: health-check
+health-check:
+	@echo "Running project health check..."
+	@domd --quiet || (echo "❌ Some commands failed. Check TODO.md" && exit 1)
+	@echo "✅ All project commands working!"
+
+.PHONY: health-report
+health-report:
+	@domd --dry-run --verbose
+```
+
+### Pre-commit Hook
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: local
+    hooks:
+      - id: domd-check
+        name: Project Command Health Check
+        entry: domd
+        language: system
+        pass_filenames: false
+        always_run: true
+```