Enables one-click installation of Django packages by injecting code in the right places.
Project description
Indjections
This project enables one-click installation of Django packages by injecting code in the right places.
Installation
Install using pip...
pip install indjections
or, if using pipenv...
pipenv install indjections --dev
Add 'indjections' to your INSTALLED_APPS setting.
INSTALLED_APPS = [
...
'indjections',
]
Example
By default, indjections assumes your TOML file is a Pipfile in the
project root. For example, say your Pipfile has the following packages:
[dev-packages]
django-debug-toolbar = "*"
[packages]
djangorestframework = "*"
django-hijack = "*"
To install these package, you just have to run a Django management command:
python manage.py indject
This will auto-insert code into settings.py, urls.py, and base.html
as described by the documentation. For example, for django-hijack, the following
snippet is added to settings.py (as described in the documentation):
### block: django-hijack ####
INSTALLED_APPS += ['hijack', 'compat']
### endblock: django-hijack ####
Moreover, if you remove this package from Pipfile and rerun python manage.py indject,
then indjections will search for ### block: django-hijack #### and delete this text.
That's it! Oh, on more thing... indjections assumes the base.html is
the Django admin base.html and is located at your project root's templates/admin/base.html.
If you want to use another base.html, you can add a setting to your project's settings.py:
INDJECTIONS_SETTINGS = {
'BASE_HTML': os.path.join(BASE_DIR, 'templates', 'custom_base.html')
}
Q&A
What if I want to modify the inserted code?
You have two options:
- If you change
### block: django-hijack ####to### block: django-hijack/lock ####, theninjectionswill not reinsert code ifpython manage.py indjectis run again. However, if the package if removed from the TOML file, thenindjectionwill delete the block even iflockappears in the block header. - Each package has an installation file located at
indjections/packages. If you create a local version of the file, then that will be used instead of theindjectiondefault installer.
What if I don't use pipenv?
The packages can be defined with any TOML file. For example, if you use poetry,
then add the following to your project's settings.py:
INDJECTIONS_SETTINGS = {
'TOML_FILE': os.path.join(BASE_DIR, 'pyproject.toml'),
'TOML_KEYS': ["tool.poetry.dependencies", "tool.poetry.dev-dependencies"],
}
How do I create my own installation file?
indjections looks for a module named indjections.packages.{packge_name}.
This declaratively defines 6 locations in a Django project:
settings: The bottom of settings.py as defined by the DJANGO_SETTINGS_MODULE environment variable.
urls: The bottom of urls.py as defined by settings.ROOT_URLCONF.
base_top: The very top of base.html e.g., {% load i18n %}
base_head: The bottom of the <head> section in base.html e.g., custom CSS.
base_body: The top of the <body> section in base.html.
base_finally: The bottom of the <body> section in base.html.
These 6 section seems to cover the vast majority of Django package installation requirements.
Additionally, indjections provides 4 hooks:
pre_hook: Functions runs before inserting code
post_hook: Functions runs after inserting code
pre_hook_delete: Functions runs before deleting code i.e., if package is removed from the TOML file
post_hook_delete: Functions runs after deleting code
For example, the installation files for django might include a post_hook
to copy Django admin template files to the project root directory.
What do I need another package?
This project has a similar goal as Cookiecutter Django.
I didn't love their approach, so I wrote indjections instead.
Cookiecutter Django is a top down approach where packages are all bundle together.
So if you don't like something, you need to spend time removing code (or write your own cookiecutter).
indjections is a bottom up approach i.e., you can do the usual django-admin startproject {project_name}
and then let python manage.py indject insert code in the right places.
Currently Supported Packages
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for indjections-0.0.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e5e088b6ae78558dbfe57b6ab4562cdb8aee7faf5fd0b455b8e3f12b5e2b8670 |
|
| MD5 | b9b0a0337ed76ea974cf169d789588da |
|
| BLAKE2b-256 | 77d024d347e28882a88d536c03cf3cc63d5033a3c0cdecf7f7e051b2fd281e4a |
