Skip to main content

A lightweight Python framework for quick project setup, similar to Django but simpler

Project description

Vibe Framework

A lightweight Python framework for quick project setup, similar to Django but simpler.

Installation

Install from source (development)

poetry install

Install as a package

Once published to PyPI, you can install with:

pip install vibe-framework

Usage

After installing vibe, you can use it in any Python project:

  1. Create a main.py file in your project directory:
def main():
    print("Hello, World!")

if __name__ == "__main__":
    main()
  1. Run the vibe command:
vibe

This will execute your main.py file. Vibe looks for a main.py file in the current directory and runs it.

Example

See example_main.py for a simple example of a main.py file that works with vibe.

Development

Running Tests

poetry run pytest

Code Formatting and Linting

This project uses pre-commit hooks for code quality. To set up:

poetry run pre-commit install

The following tools are configured:

  • black: Code formatting
  • isort: Import sorting
  • flake8: Linting

Manual Formatting

poetry run black src tests
poetry run isort src tests
poetry run flake8 src tests

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibe_framework-0.1.0.tar.gz (2.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vibe_framework-0.1.0-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file vibe_framework-0.1.0.tar.gz.

File metadata

  • Download URL: vibe_framework-0.1.0.tar.gz
  • Upload date:
  • Size: 2.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.2 Darwin/24.6.0

File hashes

Hashes for vibe_framework-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e12dc871d3e2f1200c4c11bdf52cc950d35a5aaa3eb2ae8752774b612bff6edf
MD5 f1d601c7c253e0a32863d3703bf71f1e
BLAKE2b-256 92de962e63999ed6ed07a2c2b232385ceace2bcfaca076b7ad8b2d55cb8ebb5f

See more details on using hashes here.

File details

Details for the file vibe_framework-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vibe_framework-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.2 Darwin/24.6.0

File hashes

Hashes for vibe_framework-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80f90bbfb12e234b6a06af380986addc9aaad2189346988b3bbdceeee549b4c4
MD5 6ef2b0b882f7f72736d098d733c23b0d
BLAKE2b-256 40d79f8c9aaa5661026c11fa21321de68f89dad9ad3c9f7279373be607e7342e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page