/3D-Artisan

3D Artisan is a 3D modeling application that allows users to create, edit, and manage 3D models and scenes. The application is built using Python and provides an intuitive and user-friendly interface for users to interact with 3D models and scenes.

Primary LanguageMakefileMIT LicenseMIT

Here is the revised README.md file:

🌟 About 3D Artisan

3D Artisan is a 3D modeling application that allows users to create, edit, and manage 3D models and scenes. The application is built using Python and provides an intuitive and user-friendly interface for users to interact with 3D models and scenes.

📷 Screenshots

3D Artisan Screenshot 1 3D Artisan Screenshot 2

👾 Tech Stack

  • Programming Language: Python 3.9+
  • 3D Rendering Engine: PyOpenGL
  • Database: SQLite
  • Storage: Local File System
  • Testing Framework: Pytest

🧰 Getting Started

‼️ Prerequisites

  • Python 3.9+
  • PyOpenGL
  • SQLite
  • Pytest

⚙️ Installation

  1. Clone the repository: git clone https://github.com/your-username/3d-artisan.git
  2. Install the required dependencies: pip install -r requirements.txt
  3. Install PyOpenGL: pip install PyOpenGL PyOpenGL_accelerate

Type checks

  • Run mypy 3d_artisan to check for type errors

🧪 Running Tests

  • Run pytest to run all tests
  • Run pytest -v to run all tests with verbose output

Test coverage

  • Run pytest --cov=3d_artisan to generate test coverage report

Running tests with pytest

  • Run pytest tests/test_3d_model.py to run tests for 3D model functionality

🏃 Run Locally

  1. Run python main.py to start the application
  2. Open a web browser and navigate to http://localhost:5000

👀 Usage

  • Create a new 3D model by clicking on the "Create" button
  • Edit a 3D model by selecting it and using the various tools and features
  • Manage scenes by creating, editing, and deleting scenes

🧭 Roadmap

  • v1.0: Basic 3D modeling functionality
  • v1.1: Add support for 3D model import/export
  • v1.2: Add support for scene management
  • v2.0: Add support for collaborative editing

👋 Contributing

Commiting your code

  • Fork the repository
  • Create a new branch for your feature or fix
  • Commit your changes with a descriptive commit message
  • Create a pull request

📜 Code of Conduct

  • Be respectful and considerate towards others
  • Follow the Python coding style guidelines
  • Test your code thoroughly before committing

❔ FAQ

  • Q: What is 3D Artisan? A: 3D Artisan is a 3D modeling application built using Python.
  • Q: What are the system requirements? A: Python 3.9+, PyOpenGL, SQLite, and Pytest.

⚠️ License

3D Artisan is licensed under the MIT License.

🤝 Contact

💎 Acknowledgements

  • PyOpenGL for providing a Python binding for OpenGL
  • SQLite for providing a lightweight database solution
  • Pytest for providing a testing framework