Baton V2

[abidibo]

Hi everybody!

Baton V2 is on roll.

You can already try it:

$ pip install https://github.com/otto-torino/django-baton/archive/v2.zip

Please share your thoughts here.

[agalazis]

is batonv2 django3 compatible?. It would be nice to have some badges and update the docs

[abidibo]

No,
the package is always the same: django-baton.

stil v2 is in 1.13.2 that's confusing

What do you mean? In the current master branch I've added a section to let the people know that v2 branch is on roll, and they can try it right now.
In the v2 branch everything is ready to be merged.

V2 means a major release, which actually is implemented in the v2 branch. As soon as I'll merge the v2 branch in the master branch I'll simply release django-baton==2.0.0.

The current version of Baton in PYPI is 1.13.2 which is the last release of the major version 1.

[agalazis]

ah ok thanks again so that version in v2 readme will be pumped just before release thanks!
what confused me is this package that is actually called django-baton-v2
https://pypi.org/project/django-baton-v2/
I guess after official release we will use this again?
https://pypi.org/project/django-baton/

[abidibo]

Oh ok,

no, that package is not mine. Probably someone has forked this repo and published it on PYPI with a different name:
https://pypi.org/user/Ehrenfeld_Nicolas/

Django Baton has only 1 PYPI package and currently is still at version 1.13.2. Baton v2 is in beta (just because Bootstrap 5 is in beta) but then will be merged and published as django-baton, just a new release. Probably I won't wait for bootstrap 5 to reach the 5.0.0, because it seems already very stable to me.

[agalazis]

good to know thanks!

[felipemaion]

$ pip install https://github.com/otto-torino/django-baton/archive/v2.zip
Collecting https://github.com/otto-torino/django-baton/archive/v2.zip
Downloading https://github.com/otto-torino/django-baton/archive/v2.zip
/ 5.1 MB 10.8 MB/s
ERROR: Command errored out with exit status 1:
command: /Users/maion/opt/anaconda3/envs/bollhoff/bin/python3.9 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/private/var/folders/lq/1cqwhmc562j3xqww6kx5rh1h0000gn/T/pip-req-build-vc2umxat/setup.py'"'"'; file='"'"'/private/var/folders/lq/1cqwhmc562j3xqww6kx5rh1h0000gn/T/pip-req-build-vc2umxat/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(file);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, file, '"'"'exec'"'"'))' egg_info --egg-base /private/var/folders/lq/1cqwhmc562j3xqww6kx5rh1h0000gn/T/pip-pip-egg-info-k6l7pj16
cwd: /private/var/folders/lq/1cqwhmc562j3xqww6kx5rh1h0000gn/T/pip-req-build-vc2umxat/
Complete output (13 lines):
Traceback (most recent call last):
File "", line 1, in
File "/Users/maion/opt/anaconda3/envs/bollhoff/lib/python3.9/site-packages/setuptools/init.py", line 21, in
from setuptools.dist import Distribution
File "/Users/maion/opt/anaconda3/envs/bollhoff/lib/python3.9/site-packages/setuptools/dist.py", line 34, in
from setuptools import windows_support
File "/Users/maion/opt/anaconda3/envs/bollhoff/lib/python3.9/site-packages/setuptools/windows_support.py", line 2, in
import ctypes
File "/Users/maion/opt/anaconda3/envs/bollhoff/lib/python3.9/ctypes/init.py", line 8, in
from _ctypes import Union, Structure, Array
ImportError: dlopen(/Users/maion/opt/anaconda3/envs/bollhoff/lib/python3.9/lib-dynload/_ctypes.cpython-39-darwin.so, 2): Library not loaded: @rpath/libffi.6.dylib
Referenced from: /Users/maion/opt/anaconda3/envs/bollhoff/lib/python3.9/lib-dynload/_ctypes.cpython-39-darwin.so
Reason: image not found
----------------------------------------
WARNING: Discarding https://github.com/otto-torino/django-baton/archive/v2.zip. Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.

Any clue?

[agalazis]

Hi everybody!

Baton V2 is on roll.

You can already try it:

$ pip install https://github.com/otto-torino/django-baton/archive/v2.zip

Please share your thoughts here.

I suggest sticking to commit hashes until release since lock-files will have messed up hashes with every zip file rebuild
Something like the following is less error prone:

pipenv install https://github.com/otto-torino/django-baton/archive/d6058c5.zip

[abidibo]

Baton v2 was finally released!

[etanter]

Hi @abidibo
Thanks for your great work. I have a question regarding porting from 1.13 to 2. Is there a migration guide somewhere? should it work out of of the box, or are there some breaking changes?

[abidibo]

Hi @etanter ,
it's all described in the wiki:
https://github.com/otto-torino/django-baton/wiki

[etanter]

I hadn't realized there was a wiki 🤦🏻‍♂️

[EricPobot]

Hi @abidibo

I'm exploring Baton and don't succeed in listing selected models in the configuration of an app in the menu. The provided examples are not 100% clear on this point since nothing is said about what is supposed to be the value of the key "name" in the items of the "models" setting.

I was thinking that it was supposed to be the name of the model, but what is used in the exemples does not look like a model name (they are all lower case although model names are class ones, and thus in CamelCase usually). I tried using the names of my models, but only the app title is displayed in the menu then. I tried with variations of the model name (e.g. converted to all lower case) but without any success.

What am I doing wrong here ? Is there something special to know ?

TIA for any suggestion.

[EricPobot]

Answer to myself: the name is the model name converted to lower case. I don't understand why it didn't work when I tried. It would maybe be useful to add a remark about this in the documentation.

Question: why this lower case conversion and not keeping the name untouched ?

[abidibo]

I guess I was just used to, coming from django suit

[EricPobot]

Hi,

Me again learning Baton.

I'm trying to put in a tab of model Service admin a model Profile, linked to Service with a m-to-m relation. Here is an excerpt of the models:

class Service(models.Model):
     """ A collection of usual Django model fields """

class Profile(models.Model):
    # some standard fields
    services = models.ManyToManyField(
        Service,
        verbose_name=_('services'),
        help_text=_('the services in the profile'),
        related_name='in_profiles',
    )

The inline is defined in the admin module as follows:

class InProfilesInline(admin.TabularInline):
    model = Profile.services.through
    verbose_name = 'Included in profile'
    verbose_name_plural = 'Included in profiles'
    extra = 0
    show_change_link = False

I'm trying to group the inline with other fields in a tab dedicated to the service profiles settings identified by the tab-fs-profiles class. I've defined the fieldsets attribute as follows:

fieldsets = [
    ('General info', {
        'classes': [
            'baton-tabs-init',
            # some baton-tab-xxx  tab references
            'baton-tab-group-fs-profiles--inline-in_profiles'
        ],
        'fields': (
            # fields of the first tab
        )
    }),
   # ... other tabs definitions here ...
    ('Profiles', {
        'classes': ('tab-fs-profiles',),
        'fields': (
            # fields of the Profiles tab
        )
    })
]

The result I get is:

• the "Profiles" tab is created as expected with the fields listed in its definition
• the inline is included in the main tab

What am I supposed to use as the RELATEDNAME part of the tab declaration class baton-tab-group-fs-profiles--inline-RELATEDNAME ? As illustrated above, I've used the value of the model related_name attribute as instructed in the documentation but it doesn't work. I've tried various transformations of the model attribute value of the inline, just in case, but no more luck.

Many thanks in advance for any suggestion.

[abidibo]

@EricPobot
Actually should be the related_name, this is a particular case:

 model = Profile.services.through

Baton uses the id which Django gives to the fieldset in order to move it, And Django uses the related name if present. Maybe something changes with your options. Can you add the HTML source code of the page?

[EricPobot]

@abidibo You saved my day !!! 🤩

Although I've the dev tools opened all the time, I hadn't thought about inspecting the generated HTML.

What works is the value of the inline class model attribute, but applying the following rules to it:

• drop the final ".through" part
• leave the case unchanged
• replace dots by underscores

In other words:

baton-tab-group-fs-profiles--inline-Profile_services

And the inline is now where it was supposed to be 🍾 🥳

Maybe the documentation should include this use case. As mentioned earlier, there are other points in the documentation that would deserve some rework. I'd be willing to contribute, but as a Baton-newbie and being far from mastering it, it's a bit tricky.

Many thanks for having replied so quickly 🤝

PS: while I'm at it, what is the simplest way to customize the styles ? F.i. I'd like to make the labels wider to avoid line wraps event on large displays. I'd also like to compact a bit the layout by reducing vertical space between fields. I've read the "Customization" section of the doc, but it seems to involve playing with npm, webpack and all this stuff that is still a jungle for me ;) I did some local changes (such as widening some fields) with the help of custom forms and field widget attributes adjustments, but it's not handy for admin wide customisations.

[abidibo]

@EricPobot ,
without using the recompile way (npm involved) which unleashes the full power, you can proceed as you would with any other library: overriding styles.
You can create a templates/admin/base_site.html inside one of your apps which is declared BEFORE baton in the settings INSTALLED_APP. Then copy the baton template (https://github.com/otto-torino/django-baton/blob/master/baton/templates/admin/base_site.html). And finally, just add your styles (inline, external css, as you like) at the end of the extrahead block.

[EricPobot]

Hi,

Still exploring Django-baton. I'm starting to feel a bit more comfortable with it ;)

Is there a way to include buttons in the tab of a given field set ? I'd like to move a button executing a custom action and which is currently in the "submit row" to the tab where the fields it's related to are grouped.

Thanks in advance for any suggestion.

[abidibo]

Hi @EricPobot ,

If the button can be tied to a field (top, bottom. above, below, right), you can use this:

https://github.com/otto-torino/django-baton#form-includes

You can inject templates directly inside the change form; it works also with tabs.

[EricPobot]

Waow !!! It's a amazing (and same for your very much appreciated reactivity)

I didn't understood the feature this way. It's exactly what I needed.

Thanks again 👍