Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat-solar-gracefully-barony: migrate to pipx-based installation #2

Merged
merged 4 commits into from
Jan 23, 2025
Merged

feat-solar-gracefully-barony: migrate to pipx-based installation #2

merged 4 commits into from
Jan 23, 2025

Conversation

louspringer
Copy link
Contributor

@louspringer louspringer commented Jan 19, 2025 •
edited
Loading

Migrate to pipx-based installation

Changes

  • Remove system-wide installation
  • Implement proper Python package structure
  • Add Azure OpenAI credential checks
  • Clean up legacy installation paths
  • Add ontology documentation (cllm.ttl)

Testing

  • Tested clean installation using pipx
  • Verified Azure OpenAI credential handling
  • Confirmed cleanup of legacy paths

Implementation Notes

  • Uses pipx for isolated Python package installation
  • Maintains backward compatibility
  • Properly handles Azure OpenAI credentials through environment variables
  • Removes problematic sudo requirements

Documentation

Added cllm.ttl as static documentation of:

  • Tool components and relationships
  • Installation process requirements
  • Credential management
  • Current implementation state
  • Future evolution path

Note: While cllm.ttl uses ontology notation for precise documentation, it's a static file. The ontology-framework tooling is a development dependency not required for installation or runtime operation. Development dependencies will be addressed in a future PR.

@louspringer
feat(solar-gracefully-barony): migrate to pipx-based installation
b736982 
- Remove system-wide installation
- Implement proper Python package structure
- Add Azure OpenAI credential checks
- Clean up legacy installation paths

This provides a cleaner, more isolated installation process
using pipx while maintaining proper credential handling.
@louspringer
docs(ontology): add cllm.ttl for formal documentation
fae2a95 
Add ontology documentation to:
- Document tool components and relationships
- Specify installation requirements
- Define credential management
- Map current state and evolution path
@louspringer
refactor(structure): move to src layout and update dependencies
eff88e6 
- Move cllm.py to src/cllm/main.py
- Add __init__.py for proper package
- Update requirements.txt
- Update sample usage notebook
m9e
m9e requested changes Jan 19, 2025
View reviewed changes
Copy link
Owner

@m9e m9e left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few things: sample_usage notebook has an error now; also, as I'm tracking Kamiwaza, I prefer reqs when declared to be py3.10 as opposed to 12.

requirements.txt has a --user at the top which I don't think is valid?

@louspringer
🔧 refactor: Consolidate environment setup and add ontology framework
27c8b27 
📦 Move from requirements.txt to pyproject.toml as single source of truth

🐍 Add idempotent conda/venv environment setup script

🧬 Add comprehensive ontology framework with documentation

📚 Update installation and development guides

�� Add SPARQL queries and analysis tools for ontology

📊 Add visualization support (PlantUML diagrams)

🐛 Update main.py with improved error handling
@louspringer
Copy link
Contributor Author

🔧 Major Refactor: Environment Setup & Ontology Framework

📦 Environment & Dependencies

  • Migrated from requirements.txt to pyproject.toml as single source of truth
  • Added idempotent environment setup script supporting both conda and venv
  • Improved dependency management with clear core vs dev dependencies
  • Added automatic environment detection and updating

🧬 New Ontology Framework

  • Added comprehensive ontology framework with full documentation
  • Implemented semantic model of CLI components and relationships
  • Added framework integration with soft links for flexibility
  • Included validation rules and SHACL shapes

🔍 Analysis & Development Tools

  • Added SPARQL queries for ontology analysis
  • Created Python tools for framework usage analysis
  • Added test suite for ontology validation
  • Implemented symlink management for framework dependencies

📊 Visualization & Documentation

  • Added PlantUML diagrams for:
    • Ontology structure
    • Activity flows
    • Requirements
  • Created detailed documentation:
    • Architecture guide
    • Development setup
    • Framework integration

🐛 Code Improvements

  • Enhanced error handling in main.py
  • Added proper environment variable handling
  • Improved configuration management
  • Added development tooling configuration (flake8, etc.)

🔐 Security & Best Practices

  • Improved credential handling
  • Added secure environment variable management
  • Enhanced configuration file handling
  • Added development environment isolation

📚 Documentation Updates

  • Added comprehensive setup guides
  • Improved installation instructions
  • Added development workflow documentation
  • Enhanced API documentation

🧪 Testing & Validation

  • Added framework analysis tools
  • Implemented ontology validation
  • Added development environment verification
  • Created test data and examples

This PR represents a major enhancement to the project's architecture, development workflow, and documentation. It provides a solid foundation for future semantic enhancements while maintaining backward compatibility.

@m9e m9e merged commit 4590336 into m9e:main Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m9e m9e m9e requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@louspringer @m9e