Updated documentation references to reflect the new package name. (#78)

* feat: Introduce core structure for Flask MVC

- Added core package with configuration, exceptions, file handling, and name utilities.
- Implemented controller generation logic with template rendering.
- Established middleware for routing and callback handling.
- Created input method helper for handling hidden input fields in forms.
- Developed a base controller template for MVC structure.
- Updated project structure and renamed package from `mvc_flask` to `flask_mvc`.
- Enhanced testing framework with comprehensive tests for new features.
- Updated documentation references to reflect the new package name.

* refactor(makefile): update format and check targets to specify directories

* chore: update black version to 25.1.0 and adjust Python version requirement

* chore: update pytest version to 8.4.1 in dependencies

Author: marcuxyz

.github/workflows/ci.yml

@@ -53,7 +53,7 @@ jobs:
         make check
 
     - name: Run tests
-      run: poetry run pytest --cov=mvc_flask --cov-report=xml --cov-report=term-missing
+      run: poetry run pytest --cov=flask_mvc --cov-report=xml --cov-report=term-missing
 
     - name: Upload coverage to Codecov
       if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10'
@@ -83,7 +83,7 @@ jobs:
 
     - name: Run security checks
       run: |
-        poetry run bandit -r mvc_flask
+        poetry run bandit -r flask_mvc
 
   build:
     name: Build Package

README.md

@@ -4,19 +4,19 @@
 
 ![Flask MVC Logo](https://img.shields.io/badge/Flask-MVC-blue?style=for-the-badge&logo=flask)
 
-[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/marcuxyz/mvc_flask?style=flat-square)](https://github.com/marcuxyz/mvc_flask)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/marcuxyz/mvc_flask/unit%20test?style=flat-square)](https://github.com/marcuxyz/mvc_flask/actions)
-[![GitHub](https://img.shields.io/github/license/marcuxyz/mvc_flask?style=flat-square)](https://github.com/marcuxyz/mvc_flask/blob/main/LICENSE)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/mvc_flask?style=flat-square)](https://pypi.org/project/mvc_flask/)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mvc_flask?style=flat-square)](https://pypi.org/project/mvc_flask/)
-[![PyPI](https://img.shields.io/pypi/v/mvc_flask?style=flat-square)](https://pypi.org/project/mvc_flask/)
+[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/marcuxyz/flask-mvc?style=flat-square)](https://github.com/marcuxyz/flask-mvc)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/marcuxyz/flask-mvc/unit%20test?style=flat-square)](https://github.com/marcuxyz/flask-mvc/actions)
+[![GitHub](https://img.shields.io/github/license/marcuxyz/flask-mvc?style=flat-square)](https://github.com/marcuxyz/flask-mvc/blob/main/LICENSE)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/flask_mvc?style=flat-square)](https://pypi.org/project/flask_mvc/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flask_mvc?style=flat-square)](https://pypi.org/project/flask_mvc/)
+[![PyPI](https://img.shields.io/pypi/v/flask_mvc?style=flat-square)](https://pypi.org/project/flask_mvc/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
 
 **Transform your Flask application into a structured MVC architecture with powerful CLI tools**
 
 [Installation](#installation) •
 [Quick Start](#quick-start) •
-[Documentation](https://marcuxyz.github.io/mvc-flask) •
+[Documentation](https://marcuxyz.github.io/flask-mvc) •
 [Examples](#examples) •
 [Contributing](#contributing)
 
@@ -38,20 +38,20 @@
 ### Using pip
 
 ```bash
-pip install mvc_flask
+pip install flask_mvc
 ```
 
 ### Using Poetry
 
 ```bash
-poetry add mvc_flask
+poetry add flask_mvc
 ```
 
 ### Development Installation
 
 ```bash
-git clone https://github.com/marcuxyz/mvc_flask.git
-cd mvc_flask
+git clone https://github.com/marcuxyz/flask-mvc.git
+cd flask_mvc
 poetry install
 ```
 
@@ -61,7 +61,7 @@ poetry install
 
 ```python
 from flask import Flask
-from mvc_flask import FlaskMVC
+from flask_mvc import FlaskMVC
 
 app = Flask(__name__)
 FlaskMVC(app)
@@ -74,7 +74,7 @@ if __name__ == "__main__":
 
 ```python
 from flask import Flask
-from mvc_flask import FlaskMVC
+from flask_mvc import FlaskMVC
 
 mvc = FlaskMVC()
 
@@ -242,7 +242,7 @@ export FLASK_MVC_FILE_ENCODING="utf-8"
 ### Programmatic Configuration
 
 ```python
-from mvc_flask.core.config import CLIConfig
+from flask_mvc.core.config import CLIConfig
 
 # Override default settings
 CLIConfig.DEFAULT_CONTROLLERS_PATH = "src/controllers"
@@ -255,8 +255,8 @@ Flask MVC is built with testing in mind:
 
 ```python
 import pytest
-from mvc_flask.core.generators import ControllerGenerator
-from mvc_flask.core.exceptions import InvalidControllerNameError
+from flask_mvc.core.generators import ControllerGenerator
+from flask_mvc.core.exceptions import InvalidControllerNameError
 
 def test_controller_generation():
     generator = ControllerGenerator()
@@ -272,11 +272,11 @@ def test_controller_generation():
 
 ## 📚 Documentation
 
-- **[Full Documentation](https://marcuxyz.github.io/mvc-flask)** - Complete guide and API reference
-- **[Quick Start Guide](https://marcuxyz.github.io/mvc-flask/quickstart)** - Get up and running fast
-- **[Controller Guide](https://marcuxyz.github.io/mvc-flask/controllers)** - Working with controllers
-- **[Router Guide](https://marcuxyz.github.io/mvc-flask/router)** - Route configuration
-- **[CLI Reference](https://marcuxyz.github.io/mvc-flask/cli)** - Command-line tools
+- **[Full Documentation](https://marcuxyz.github.io/flask-mvc)** - Complete guide and API reference
+- **[Quick Start Guide](https://marcuxyz.github.io/flask-mvc/quickstart)** - Get up and running fast
+- **[Controller Guide](https://marcuxyz.github.io/flask-mvc/controllers)** - Working with controllers
+- **[Router Guide](https://marcuxyz.github.io/flask-mvc/router)** - Route configuration
+- **[CLI Reference](https://marcuxyz.github.io/flask-mvc/cli)** - Command-line tools
 
 ## 🤝 Contributing
 
@@ -286,8 +286,8 @@ We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.
 
 ```bash
 # Clone the repository
-git clone https://github.com/marcuxyz/mvc_flask.git
-cd mvc_flask
+git clone https://github.com/marcuxyz/flask-mvc.git
+cd flask_mvc
 
 # Install dependencies
 poetry install
@@ -305,8 +305,8 @@ poetry run mkdocs serve
 
 ### Reporting Issues
 
-- **[Bug Reports](https://github.com/marcuxyz/mvc_flask/issues/new?template=bug_report.md)**
-- **[Feature Requests](https://github.com/marcuxyz/mvc_flask/issues/new?template=feature_request.md)**
+- **[Bug Reports](https://github.com/marcuxyz/flask-mvc/issues/new?template=bug_report.md)**
+- **[Feature Requests](https://github.com/marcuxyz/flask-mvc/issues/new?template=feature_request.md)**
 
 ## 📋 Requirements
 
@@ -327,9 +327,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## 📊 Stats
 
-![GitHub stars](https://img.shields.io/github/stars/marcuxyz/mvc_flask?style=social)
-![GitHub forks](https://img.shields.io/github/forks/marcuxyz/mvc_flask?style=social)
-![GitHub watchers](https://img.shields.io/github/watchers/marcuxyz/mvc_flask?style=social)
+![GitHub stars](https://img.shields.io/github/stars/marcuxyz/flask-mvc?style=social)
+![GitHub forks](https://img.shields.io/github/forks/marcuxyz/flask-mvc?style=social)
+![GitHub watchers](https://img.shields.io/github/watchers/marcuxyz/flask-mvc?style=social)
 
 ---
 

REFACTOR_SUMMARY.md

@@ -1,4 +1,4 @@
-# MVC Flask Test Refactor Summary
+# Flask MVC Test Refactor Summary
 
 ## Final Status: ✅ COMPLETED SUCCESSFULLY
 

docs/index.md

@@ -2,35 +2,35 @@
 
 <p align="center">This extension facilitates the application of this design pattern in Flask </p>
 <p align="center">
-    <a href="https://github.com/marcuxyz/mvc-flask/actions/workflows/test.yml">
-        <img src="https://github.com/marcuxyz/mvc-flask/actions/workflows/test.yml/badge.svg?branch=main" alt="unit test" height="18">
+    <a href="https://github.com/marcuxyz/flask-mvc/actions/workflows/test.yml">
+        <img src="https://github.com/marcuxyz/flask-mvc/actions/workflows/test.yml/badge.svg?branch=main" alt="unit test" height="18">
     </a>
-    <a href="https://badge.fury.io/py/mvc-flask">
-        <img src="https://badge.fury.io/py/mvc-flask.svg" alt="PyPI version" height="18">
+    <a href="https://badge.fury.io/py/flask-mvc">
+        <img src="https://badge.fury.io/py/flask-mvc.svg" alt="PyPI version" height="18">
     </a>
 </p>
 
 
 Designed to allow developers to implement the Model-View-Controller (MVC) design pattern in Flask applications with the help of this extension.
 <hr />
 
-Install MVC Flask using pip:
+Install Flask MVC using pip:
 
 ```shell
-$ pip install mvc_flask
+$ pip install flaskmvc
 ```
 
-Install MVC Flask using poetry:
+Install Flask MVC using poetry:
 
 ```shell
-$ poetry add mvc_flask
+$ poetry add flaskmvc
 ```
 
 Now, let's get started:
 
 ```python
 from flask import Flask
-from mvc_flask import FlaskMVC
+from flask_mvc import FlaskMVC
 from flask_sqlalchemy import SQLAlchemy
 
 db = SQLAlchemy()
@@ -50,7 +50,7 @@ def create_app():
 
 ## Features
 
-MVC Flask builds on provides the best architecture experience for Flask, and gives you:
+Flask MVC builds on provides the best architecture experience for Flask, and gives you:
 
 - You can directories as controllers, models, and views.
 - It Supports the controllers' creation, and you can separate the logic of your application of business rules
@@ -60,4 +60,4 @@ MVC Flask builds on provides the best architecture experience for Flask, and giv
 
 ## Dependencies
 
-MVC Flask just depends on the Flask extensions to working and requires Python >=3.8.0,<4.0.0.
+Flask MVC just depends on the Flask extensions to working and requires Python >=3.8.0,<4.0.0.

docs/quickstart.md

@@ -1,10 +1,10 @@
 # Quickstart
 
-To start the use `mvc_flask` you need to import and register in your application, e.g:
+To start the use `flask_mvc` you need to import and register in your application, e.g:
 
 ```python
 from flask import Flask
-from mvc_flask import FlaskMVC
+from flask_mvc import FlaskMVC
 
 app = Flask(__name__)
 FlaskMVC(app)
@@ -32,7 +32,7 @@ app
     ├── index.html
 ```
 
-**By default, the mvc_flask assumes that your application directory will be app and if it doesn't exist, create it! If you can use another directory, you can use the path parameter when the instance of FlaskMVC is initialized. E.g:**
+**By default, the flask_mvc assumes that your application directory will be app and if it doesn't exist, create it! If you can use another directory, you can use the path parameter when the instance of FlaskMVC is initialized. E.g:**
 
 ```python
 mvc = FlaskMVC()

docs/router.md

@@ -3,7 +3,7 @@
 You can create routes in `app/routes.py` and after creating file, you can start to register routes, e.g:
 
 ```python
-from mvc_flask import Router
+from flask_mvc import Router
 
 Router.get("/", "home#index")
 ```
@@ -54,7 +54,7 @@ The parameter only accept `string` or `array`, so, you can use `only=["index", "
 You can use namespaces to group the routes.
 
 ```python
-from mvc_flask import Router
+from flask_mvc import Router
 
 api = Router.namespace("/api/v1")
 

docs/views.md

@@ -1,6 +1,6 @@
 # Views
 
-Flask uses the templates directory by default to store HTML files. However, using the `mvc-flask` the default becomes `views`.
+Flask uses the templates directory by default to store HTML files. However, using the `flask-mvc` the default becomes `views`.
 You can use the app/views directory to store templates.
 
 Please if you create template, use `views` for folder name, instead of `templates`.

flask_mvc/__init__.py

@@ -0,0 +1,3 @@
+from .flask_mvc import FlaskMVC, Router
+
+__all__ = ["FlaskMVC", "Router"]

mvc_flask/__version__.py renamed to flask_mvc/__version__.py

@@ -24,7 +24,7 @@
 
 @click.group()
 def mvc():
-    """MVC Flask commands."""
+    """Flask MVC commands."""
     pass