quickscale 0.1.0__tar.gz

quickscale-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quickscale-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+# Include all template files for project generation
+recursive-include quickscale/templates *
+
+# Include all script files for project management
+recursive-include quickscale/scripts *
+
+# Include documentation and license
+include LICENSE
+include README.md

quickscale-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: quickscale
+Version: 0.1.0
+Summary: A SaaS starter kit for Python-first developers using Django
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: django>=5.0.1
+Requires-Dist: whitenoise>=6.6.0
+Requires-Dist: uvicorn>=0.27.0
+Requires-Dist: psycopg2-binary>=2.9.9
+Requires-Dist: dj-database-url>=2.1.0
+Requires-Dist: python-dotenv>=1.0.0
+Dynamic: license-file

quickscale-0.1.0/README.md

@@ -0,0 +1,273 @@
+# **🚀 Quick-Scale**  
+
+**A SaaS starter kit for Python-first developers using Django**  
+
+Quick-Scale is designed to help **AI/ML engineers, Data Scientists, and Backend/Cloud developers** launch SaaS applications **quickly and efficiently**. It provides a **ready-to-use** Django-based framework with best practices for **scalability, authentication, billing, and deployment**—so you can focus on building your product, not setting up infrastructure.  
+
+👉 **Go from idea to paying customers with minimal setup.**  
+
+Ideal for **solo developers** or small teams looking to turn their ideas into production-ready SaaS solutions **with minimal effort**.  
+
+## GET STARTED 🔥 - LAUNCH QUICKLY 🚀
+
+1.  Install: `pip install quickscale`
+2.  Create project: `quickscale build awesome-project`
+3.  Access Local Deployment: `http://localhost:8000`
+
+## TECHNICAL STACK
+- Django 5.0.1+ (backend framework)
+    - Whitenoise 6.6.0+ (static files)
+    - Psycopg2-binary 2.9.9+ (PostgreSQL adapter)
+    - Python-dotenv 1.0.0+ (environment variables)
+    - dj-database-url 2.1.0+ (database URL configuration)
+    - Uvicorn 0.27.0+ (ASGI server)
+- HTMX (frontend to backend communication for CRUD operations with the simplicity of HTML)
+- Alpine.js (simple vanilla JS library for DOM manipulation)
+- Bulma CSS (simple CSS styling without JavaScript)
+- PostgreSQL (database)
+- Deployment: .env + Docker + Uvicorn
+
+
+## PROJECT USAGE
+
+QuickScale provides a convenient command-line interface to manage your projects:
+
+```
+Available commands:
+  build          - Build a new QuickScale project
+  up             - Start the project services
+  down           - Stop the project services
+  logs           - View project logs (optional service parameter: web, db)
+  manage         - Run Django management commands
+  check          - Check project status and requirements
+  clean          - Clean temporary files and cached data
+  update         - Update project dependencies and configuration
+  ps             - Show the status of running services
+  destroy        - Permanently destroy the current project (Warning deletes all code)
+  help           - Show this help message
+  version        - Show the current version of QuickScale
+```
+
+Examples:
+```bash
+quickscale build awesome-project   # Create a new project called "awesome-project"
+quickscale up                      # Start the services
+quickscale logs web                # View logs from the web service
+quickscale down                    # Stop the services
+```
+
+## DJANGO MANAGE COMMANDS
+
+QuickScale seamlessly integrates with Django's management commands through the `quickscale manage` command. This allows you to run any Django management command within your project's Docker container.
+
+Common Django management commands:
+
+```bash
+# Database management
+quickscale manage migrate           # Run database migrations
+quickscale manage makemigrations    # Create new migrations based on model changes
+quickscale manage sqlmigrate app_name migration_name  # SQL statements for migration
+
+# Development server
+quickscale manage runserver         # Run development server (rarely needed as Docker handles this)
+
+# User management
+quickscale manage createsuperuser   # Create a Django admin superuser
+quickscale manage changepassword    # Change a user's password
+
+# Application management
+quickscale manage startapp app_name # Create a new Django app
+quickscale manage shell             # Open Django interactive shell
+quickscale manage dbshell           # Open database shell
+
+# Static files
+quickscale manage collectstatic     # Collect static files
+quickscale manage findstatic        # Find static file locations
+
+# Testing
+quickscale manage test              # Run all tests
+quickscale manage test app_name     # Run tests for specific app
+quickscale manage test app.TestClass # Run tests in a specific test class
+quickscale manage test app.TestClass.test_method # Run a specific test method
+
+# Maintenance
+quickscale manage clearsessions     # Clear expired sessions
+quickscale manage flush             # Remove all data from database
+quickscale manage dumpdata          # Export data from database
+quickscale manage loaddata          # Import data to database
+
+# Inspection
+quickscale manage check             # Check for project issues
+quickscale manage diffsettings      # Display differences between current settings and Django defaults
+quickscale manage inspectdb         # Generate models from database
+quickscale manage showmigrations    # Show migration status
+```
+
+When using the `test` command, if a test fails or dependencies are missing, QuickScale will provide informative error messages to help you troubleshoot the issue.
+
+## STARTER PAGES
+- Public: 
+  - Home: Landing page.
+  - Login: Login page.
+  - Register: Register page.
+  - Contact: Contact page.
+  - About: About page.
+  - Navigation Bar: Navigation bar.
+- User Private: 
+  - Dashboard: Dashboard page.
+  - Profile: Profile page.
+  - Settings: Settings page.
+- Admin Private: 
+  - Dashboard: Dashboard page.
+  - Profile: Profile page.
+  - Settings: Settings page.
+  - Users CRUD.
+
+## PROJECT STRUCTURE
+```
+project-name/
+├── README.md                 # Project documentation
+├── docker-compose.yml        # Docker Compose configuration
+├── Dockerfile                # Docker configuration
+├── requirements.txt          # Python dependencies
+├── .env                      # Environment variables
+├── .dockerignore             # Docker ignore file
+├── core/                     # Core Django project
+│   ├── settings.py           # Project settings
+│   └── urls.py               # Main URL configuration
+├── common/                   # Common Django app
+│   ├── apps.py
+│   ├── urls.py
+│   ├── views.py
+│   └── templates/            # App-specific templates
+├── dashboard/                # Dashboard Django app
+│   ├── apps.py
+│   ├── urls.py
+│   ├── views.py
+│   └── templates/            # App-specific templates
+├── public/                   # Public Django app
+│   ├── apps.py
+│   ├── urls.py
+│   ├── views.py
+│   └── templates/            # App-specific templates
+├── users/                    # Users Django app
+│   ├── apps.py
+│   ├── urls.py
+│   ├── views.py
+│   └── templates/            # App-specific templates
+└── templates/                # Global templates
+    ├── base/                 # Base templates
+    │   └── base.html
+    ├── base.html
+    ├── components/           # Reusable components
+    │   ├── footer.html
+    │   ├── messages.html
+    │   └── navbar.html
+    ├── dashboard/            # Dashboard templates
+    │   └── index.html
+    ├── public/               # Public templates
+    │   ├── about.html
+    │   ├── contact.html
+    │   ├── home.html
+    │   └── index.html
+    └── users/                # User templates
+        ├── login.html
+        ├── login_form.html
+        ├── profile.html
+        └── signup.html
+```
+
+## APPLICATION STRUCTURE
+
+### Django Apps
+1. **core**: Main Django project settings and URL configuration
+2. **public**: Public-facing pages (home, about, contact)
+3. **users**: User authentication and profile management
+4. **dashboard**: User dashboard and private pages
+5. **common**: Shared functionality across apps
+
+### Templates Structure
+1. **base**: Base HTML templates that other templates extend
+2. **components**: Reusable HTML components (navbar, footer, messages)
+3. **public**: Templates for public pages
+4. **users**: Templates for user authentication and profile
+5. **dashboard**: Templates for the user dashboard
+
+## ENVIRONMENT VARIABLES
+
+The project uses the following environment variables:
+
+| Variable            | Description               | Default                                      |
+|---------------------|---------------------------|----------------------------------------------|
+| DEBUG               | Debug mode                | True                                         |
+| SECRET_KEY          | Django secret key         | Automatically generated secure random string |
+| DATABASE_URL        | PostgreSQL connection URL | postgresql://admin:adminpasswd@db:5432/admin |
+| POSTGRES_HOST       | PostgreSQL host           | db                                           |
+| POSTGRES_DB         | PostgreSQL database name  | admin                                        |
+| POSTGRES_USER       | PostgreSQL username       | admin                                        |
+| POSTGRES_PASSWORD   | PostgreSQL password       | adminpasswd                                  |
+| EMAIL_HOST_USER     | SMTP username for emails  | -                                            |
+| EMAIL_HOST_PASSWORD | SMTP password for emails  | -                                            |
+
+## DOCKER CONFIGURATION
+
+The project uses Docker and Docker Compose for containerization:
+
+1. **Web Container**: Django application
+   - Base image: python:3.11-slim
+   - Exposed port: 8000
+   - Volumes: Local directory mounted to /app
+
+2. **Database Container**: PostgreSQL
+   - Image: postgres:15
+   - Exposed port: 5432
+   - Volumes: Persistent volume for data
+
+## STARTER DATABASE
+
+- User: 
+  - user: user
+  - password: userpasswd
+  - email: user@test.com
+
+- Administrator: 
+  - user: admin
+  - password: adminpasswd
+  - email: admin@test.com
+
+## HTMX INTEGRATION
+
+HTMX is used for dynamic content loading and form submissions without full page reloads:
+
+1. **Form submissions**: Login, signup, and contact forms
+2. **Dynamic content loading**: Dashboard components
+3. **Real-time updates**: Notifications and messages
+
+## ALPINE.JS INTEGRATION
+
+Alpine.js is used for client-side interactivity and state management:
+
+1. **Dropdown menus**: Navigation bar
+2. **Modal dialogs**: Confirmation dialogs
+3. **Form validation**: Client-side validation
+
+## CHANGELOG
+
+### v0.1.0 (2025-03-19)
+- Initial release of QuickScale
+- Basic documentation for setup and usage
+- Basic project structure
+- Core Django setup
+- Basic user authentication features
+- Basic Docker and Docker Compose configuration
+- Basic PostgreSQL setup
+- Basic HTMX and Alpine.js integration
+- Basic Bulma CSS integration
+- Basic templates and components
+- Basic environment variables
+- Basic Deploy to local
+
+
+
+
+

quickscale-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=64.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quickscale"
+dynamic = ["version"]
+description = "A SaaS starter kit for Python-first developers using Django"
+requires-python = ">=3.10"
+dependencies = [
+    # Django and core dependencies
+    "django>=5.0.1",
+    "whitenoise>=6.6.0",
+    "uvicorn>=0.27.0",
+    # Database
+    "psycopg2-binary>=2.9.9",
+    "dj-database-url>=2.1.0",
+    # Environment and configuration
+    "python-dotenv>=1.0.0",
+]
+
+[project.scripts]
+quickscale = "quickscale.cli:main"
+
+[tool.setuptools]
+packages = ["quickscale"]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "quickscale.__version__"}
+
+[tool.setuptools.package-data]
+quickscale = [
+    "templates/**/*",
+    "scripts/**/*"
+]

quickscale-0.1.0/quickscale/__init__.py

@@ -0,0 +1,11 @@
+# QuickScale - A Django SaaS Starter Kit for Python-First Developers
+
+# Single source of truth for package version
+__version__ = "0.1.0"
+
+try:
+    from importlib.metadata import version
+    __version__ = version("quickscale")
+except ImportError:
+    # Package is not installed
+    pass