Package: django-venv
Django VenvThis repository contains a set of Python and Bash scripts designed to simplify the process of setting up a development environment for Django projects. Whether you are a seasoned Django developer or just starting out, these scripts aim to streamline common tasks and make it easier to get your Django project up and running quickly.Table of ContentsAbout The ProjectFeaturesBuilt WithGetting StartedPrerequisitesInstallationUsageCommand-Line OptionsUsage ExampleUpcoming FeaturesCode of ConductContributingLicenseAcknowledgmentsFeaturesDjango-Venv provides the following features:Virtual Environment Setup: Automatically creates a virtual environment and installs project dependencies.Django Project Initialization: Automates the creation of a Django project, along with additional directories and files such as static files, apps directory, and a base.html template.Django Settings Configuration: Edits thesettings.pyfile to include various settings, including database configuration (MySQL, PostgreSQL) with docker, htmx setup, SMTP configuration, and other common settings.Database Setup: Users have the option to either utilize their own server or have the script generate a Docker container for the specified database. When opting for MySQL or other compatible databases, the script will endeavor to create a Docker container with your chosen database, establish a user profile with the requisite permissions, set up a database, and store the credentials securely in an .env file.Built With(back to top)Getting StartedPrerequisitesBefore you begin, please ensure that you have the following dependencies installed on your system:Linux Operating System: Django-Venv is designed to work on Linux-based systems.Docker: Django-Venv relies on Docker for certain functionality. Make sure you have Docker installed on your machine. You can find installation instructions for Docker on theDocker website.Once you have these dependencies in place, you can proceed with the installation and usage of Django-Venv.(back to top)InstallationTo get started, follow these steps:Install the package:pipinstalldjango-venvUsageRun the script to set up your Django project:django-venv<project_name>Command-Line Optionsdjango-venv<project_name>[OPTIONS]Options:-h,--helpDisplaythishelpmessage-d,--database<database_type>Specifythedatabasetype(required)Choosebetween'mysql'or'postgre'--smtpConfigureSMTPsettingsinsettings.py--htmxConfigureHTMXsettingsinsettings.py(back to top)Usage Exampledjango-venv<project_name>-dmysql--htmx--smtpThis will generatesettings.py, an '.env' file with all the credentials, a locally running MySQL Docker container if the database is not specified, as well as all the static directories and application directories for the Django project.(back to top)Upcoming FeaturesCassandra Support with Docker: Integrate support for Cassandra databases with Docker.Scylla Support with Docker: Extend our Docker support to include Scylla, a highly available NoSQL database compatible with Apache Cassandra.(back to top)Code of ConductPlease review ourCode of Conductbefore contributing to Django-Venv.(back to top)ContributingWe welcome contributions from the community! Please see ourContributing Guidelinesfor more information.(back to top)LicenseDistributed under the Apache-2.0 license. See LICENSE for more information.(back to top)AcknowledgmentsYapf Python formatterast-comments(back to top)