# Vibe Framework
A lightweight Python framework for quick project setup, similar to Django but simpler.
## Installation
### Install from source (development)
```bash
poetry install
```
### Install as a package
Once published to PyPI, you can install with:
```bash
pip install vibe-framework
```
## Quick Start
### Create a new project
```bash
# Create project in current directory
vibe init
# Or create project in a new directory
vibe init myproject
```
This creates:
- `main.py` - Your main application file
- `tests/` - Test directory with example tests
- `pytest.ini` - Pytest configuration
- `requirements.txt` - Python dependencies
### Run your project
```bash
vibe
```
This executes your `main.py` file.
### Run tests
```bash
vibe test
```
This runs all tests in the `tests/` directory using pytest.
## Commands
- `vibe` - Run the main.py file in the current directory
- `vibe init [project_name]` - Initialize a new vibe project
- `vibe test` - Run tests using pytest
## Example
See `example_main.py` for a simple example of a main.py file that works with vibe.
## Development
### Running Tests
```bash
poetry run pytest
```
### Code Formatting and Linting
This project uses pre-commit hooks for code quality. To set up:
```bash
poetry run pre-commit install
```
The following tools are configured:
- **black**: Code formatting
- **isort**: Import sorting
- **flake8**: Linting
### Manual Formatting
```bash
poetry run black src tests
poetry run isort src tests
poetry run flake8 src tests
```
## License
MIT License - see LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/vibe-framework",
"name": "vibe-framework",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "framework, cli, development, tool",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/26/af/4a229424edc199c0dc0a287bc0dd9ea5fd383ee6f071d8e0ef5c333fb4f6/vibe_framework-0.2.0.tar.gz",
"platform": null,
"description": "# Vibe Framework\n\nA lightweight Python framework for quick project setup, similar to Django but simpler.\n\n## Installation\n\n### Install from source (development)\n\n```bash\npoetry install\n```\n\n### Install as a package\n\nOnce published to PyPI, you can install with:\n\n```bash\npip install vibe-framework\n```\n\n## Quick Start\n\n### Create a new project\n\n```bash\n# Create project in current directory\nvibe init\n\n# Or create project in a new directory\nvibe init myproject\n```\n\nThis creates:\n- `main.py` - Your main application file\n- `tests/` - Test directory with example tests\n- `pytest.ini` - Pytest configuration\n- `requirements.txt` - Python dependencies\n\n### Run your project\n\n```bash\nvibe\n```\n\nThis executes your `main.py` file.\n\n### Run tests\n\n```bash\nvibe test\n```\n\nThis runs all tests in the `tests/` directory using pytest.\n\n## Commands\n\n- `vibe` - Run the main.py file in the current directory\n- `vibe init [project_name]` - Initialize a new vibe project\n- `vibe test` - Run tests using pytest\n\n## Example\n\nSee `example_main.py` for a simple example of a main.py file that works with vibe.\n\n## Development\n\n### Running Tests\n\n```bash\npoetry run pytest\n```\n\n### Code Formatting and Linting\n\nThis project uses pre-commit hooks for code quality. To set up:\n\n```bash\npoetry run pre-commit install\n```\n\nThe following tools are configured:\n- **black**: Code formatting\n- **isort**: Import sorting\n- **flake8**: Linting\n\n### Manual Formatting\n\n```bash\npoetry run black src tests\npoetry run isort src tests\npoetry run flake8 src tests\n```\n\n## License\n\nMIT License - see LICENSE file for details.",
"bugtrack_url": null,
"license": "MIT",
"summary": "A lightweight Python framework for quick project setup, similar to Django but simpler",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/vibe-framework",
"Repository": "https://github.com/yourusername/vibe-framework"
},
"split_keywords": [
"framework",
" cli",
" development",
" tool"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e977161244f6d73770c8e819d4642066349a46678365c2b4509fffba12c53fe",
"md5": "9b3a55ea816e3a02f96884079c341328",
"sha256": "a34fbac133c6402291e0f2d6d8bf179361da680240b243d73404b93a9b888177"
},
"downloads": -1,
"filename": "vibe_framework-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b3a55ea816e3a02f96884079c341328",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 4640,
"upload_time": "2025-08-02T04:29:21",
"upload_time_iso_8601": "2025-08-02T04:29:21.308036Z",
"url": "https://files.pythonhosted.org/packages/3e/97/7161244f6d73770c8e819d4642066349a46678365c2b4509fffba12c53fe/vibe_framework-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26af4a229424edc199c0dc0a287bc0dd9ea5fd383ee6f071d8e0ef5c333fb4f6",
"md5": "1f5ffbcb081850278043560716b748f2",
"sha256": "9eea47ae2a353371e960dc2d0aa2129d203e784ed63d6bc0e8ba0e51a10fa028"
},
"downloads": -1,
"filename": "vibe_framework-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "1f5ffbcb081850278043560716b748f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 3692,
"upload_time": "2025-08-02T04:29:22",
"upload_time_iso_8601": "2025-08-02T04:29:22.469752Z",
"url": "https://files.pythonhosted.org/packages/26/af/4a229424edc199c0dc0a287bc0dd9ea5fd383ee6f071d8e0ef5c333fb4f6/vibe_framework-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-02 04:29:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "vibe-framework",
"github_not_found": true,
"lcname": "vibe-framework"
}
JSON
