django-include-apps 0.1.3

CLI tool to install and add packages to Django in INSTALLED_APPS

django-include-apps

=====================================

django-include-apps is a CLI tool to help you manage Django apps in the INSTALLED_APPS list in your Django project's settings.py file. This tool simplifies the process of adding new apps by ensuring they are properly installed and integrated into your Django project.

Features

• Automatically search for settings.py in the current or specified directory.
• Check if the package is installed; if not, prompt the user to install it.
• Verify if the package is related to Django before adding it to INSTALLED_APPS.
• Only Add the new app to the INSTALLED_APPS list if it's not already present.

Installation.

You can install django-include-apps via pip:

pip install django-include-apps

Usage

Basic Command

To add a new app to INSTALLED_APPS, use the following command:

django-include-apps add_app <new_app>

Replace <new_app> with the name of the Django app you want to add.

Project Link

For more details, visit the PyPI project page

Options:

Use --start-dir or -d to specify the directory to search for settings.py. Defaults to the current directory if not provided.

Examples:

Example 1: settings.py in the Current Directory

Suppose your Django project's settings.py file is in the current working directory. Navigate to your project directory:

cd /path/to/your/django/project

Run the CLI command to add a new app:

django-include-apps add_app <my_new_app>

Example 2: settings.py in a Different Directory

Suppose your Django project's settings.py file is in a different directory, such as /path/to/your/django/project/config. Navigate to your desired starting directory:

cd /path/to/your/django/project

Run the CLI command with the --start-dir or -d option:

django-include-apps add_app <my_new_app> --start-dir /path/to/dir

Example 3: multiple python packages in a single line

Suppose you want to install and include multiple packages and apps to Django project's settings.py file you can use this CLI.

cd /path/to/your/django/project

Run the CLI command with the --start-dir or -d option:

django-include-apps add_apps <my_new_app1> <my_new_app2> <my_new_app3> --start-dir /path/to/dir

TODO

• Support including multiple packages in single command
• Remove app added to INSTALLED_APPS
• Auto generate requirements.txt and tracking it.