| Name | lunexa-core JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Umbrella CLI & shared utils for all Lunexa projects |
| upload_time | 2025-07-13 06:03:46 |
| maintainer | None |
| docs_url | None |
| author | Simbarashe Timire |
| requires_python | <3.13,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Lunexa Core
> Umbrella CLI & shared utilities for all Lunexa projects
[](https://github.com/Lunexa-AI/lunexa-core/actions)
[](https://opensource.org/licenses/MIT)
A modern Python monorepo scaffold with plugin architecture, FastAPI integration, and comprehensive development tooling.
## 🚀 Quick Start
### Prerequisites
- Python 3.9+
- [Poetry](https://python-poetry.org/docs/#installation)
### Installation
```bash
# Clone the repository
git clone https://github.com/Lunexa-AI/lunexa-core.git
cd lunexa-core
# Install dependencies
poetry install --with dev
# Test the CLI
poetry run lunexa --help
```
### Basic Usage
```bash
# Show version
poetry run lunexa version
# Show project info
poetry run lunexa info
# Start API server
poetry run lunexa api serve
```
## 🐳 Docker
```bash
# Build and run with Docker
docker build -t lunexa-core:latest .
docker run lunexa-core:latest --help
```
## 🛠️ Development
### Setup Development Environment
```bash
# Install dependencies and pre-commit hooks
make dev-setup
# Run quick checks
make check
# Run full CI simulation
make ci
```
### Common Commands
```bash
# Code quality
make format # Format code
make lint # Run linting
make type-check # Type checking
make test # Run tests
# Docker
make docker-build # Build Docker image
make docker-test # Test Docker functionality
# Version management
make bump-patch # Bump patch version
make bump-minor # Bump minor version
make bump-major # Bump major version
```
## 📚 Documentation
- **[Development Guide](docs/README.md)** - Detailed development setup and workflows
- **[API Documentation](docs/API.md)** - FastAPI plugin documentation
- **[Testing Guide](TESTING.md)** - Comprehensive testing instructions
## 🏗️ Project Structure
```
lunexa-core/
├── src/lunexa/ # Core CLI and utilities
├── plugins/api/ # FastAPI plugin
├── tests/ # Test suite
├── docs/ # Documentation
├── examples/ # Usage examples
└── .github/ # CI/CD workflows
```
## 🤝 Contributing
1. Fork the repository
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3. Make your changes and run: `make ci`
4. Commit your changes: `git commit -m 'Add amazing feature'`
5. Push to the branch: `git push origin feature/amazing-feature`
6. Open a Pull Request
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "lunexa-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Simbarashe Timire",
"author_email": "stimire92@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/d1/a9768d80d0acf39e61cc93d54d97069c59918d60ce177ff508e9bbad888d/lunexa_core-0.1.0.tar.gz",
"platform": null,
"description": "# Lunexa Core\n\n> Umbrella CLI & shared utilities for all Lunexa projects\n\n[](https://github.com/Lunexa-AI/lunexa-core/actions)\n[](https://opensource.org/licenses/MIT)\n\nA modern Python monorepo scaffold with plugin architecture, FastAPI integration, and comprehensive development tooling.\n\n## \ud83d\ude80 Quick Start\n\n### Prerequisites\n- Python 3.9+\n- [Poetry](https://python-poetry.org/docs/#installation)\n\n### Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/Lunexa-AI/lunexa-core.git\ncd lunexa-core\n\n# Install dependencies\npoetry install --with dev\n\n# Test the CLI\npoetry run lunexa --help\n```\n\n### Basic Usage\n\n```bash\n# Show version\npoetry run lunexa version\n\n# Show project info\npoetry run lunexa info\n\n# Start API server\npoetry run lunexa api serve\n```\n\n## \ud83d\udc33 Docker\n\n```bash\n# Build and run with Docker\ndocker build -t lunexa-core:latest .\ndocker run lunexa-core:latest --help\n```\n\n## \ud83d\udee0\ufe0f Development\n\n### Setup Development Environment\n\n```bash\n# Install dependencies and pre-commit hooks\nmake dev-setup\n\n# Run quick checks\nmake check\n\n# Run full CI simulation\nmake ci\n```\n\n### Common Commands\n\n```bash\n# Code quality\nmake format # Format code\nmake lint # Run linting\nmake type-check # Type checking\nmake test # Run tests\n\n# Docker\nmake docker-build # Build Docker image\nmake docker-test # Test Docker functionality\n\n# Version management\nmake bump-patch # Bump patch version\nmake bump-minor # Bump minor version\nmake bump-major # Bump major version\n```\n\n## \ud83d\udcda Documentation\n\n- **[Development Guide](docs/README.md)** - Detailed development setup and workflows\n- **[API Documentation](docs/API.md)** - FastAPI plugin documentation\n- **[Testing Guide](TESTING.md)** - Comprehensive testing instructions\n\n## \ud83c\udfd7\ufe0f Project Structure\n\n```\nlunexa-core/\n\u251c\u2500\u2500 src/lunexa/ # Core CLI and utilities\n\u251c\u2500\u2500 plugins/api/ # FastAPI plugin\n\u251c\u2500\u2500 tests/ # Test suite\n\u251c\u2500\u2500 docs/ # Documentation\n\u251c\u2500\u2500 examples/ # Usage examples\n\u2514\u2500\u2500 .github/ # CI/CD workflows\n```\n\n## \ud83e\udd1d Contributing\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature/amazing-feature`\n3. Make your changes and run: `make ci`\n4. Commit your changes: `git commit -m 'Add amazing feature'`\n5. Push to the branch: `git push origin feature/amazing-feature`\n6. Open a Pull Request\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Umbrella CLI & shared utils for all Lunexa projects",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1d7935e9cd28165e6f37491b4f7f601ca54a13a42f76fb4d2ef6e593341be343",
"md5": "ff467b05ca56ccce1a70ead20b70a4c8",
"sha256": "1d0f9a9bc56f2bc314ea63041b35eb6d36dae83c00d1e3d360d4ae2ff9604c67"
},
"downloads": -1,
"filename": "lunexa_core-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff467b05ca56ccce1a70ead20b70a4c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 6224,
"upload_time": "2025-07-13T06:03:45",
"upload_time_iso_8601": "2025-07-13T06:03:45.088636Z",
"url": "https://files.pythonhosted.org/packages/1d/79/35e9cd28165e6f37491b4f7f601ca54a13a42f76fb4d2ef6e593341be343/lunexa_core-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b4d1a9768d80d0acf39e61cc93d54d97069c59918d60ce177ff508e9bbad888d",
"md5": "216f8803e8fdbf0f633c515c8e1321d6",
"sha256": "a7d4f586da6da535dd63674934a6a06b3f7210fbce62ffde8f7cbb80d1db97e9"
},
"downloads": -1,
"filename": "lunexa_core-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "216f8803e8fdbf0f633c515c8e1321d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 5181,
"upload_time": "2025-07-13T06:03:46",
"upload_time_iso_8601": "2025-07-13T06:03:46.474289Z",
"url": "https://files.pythonhosted.org/packages/b4/d1/a9768d80d0acf39e61cc93d54d97069c59918d60ce177ff508e9bbad888d/lunexa_core-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-13 06:03:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "lunexa-core"
}
