django-crispy-forms / django-crispy-forms/crispy-tailwind
To Do
- Dominant language
- HTML
- Stars
- 423
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
Description
Hi @carltongibson @bittermandel
I've pushed an initial commit based upon the pull request to django-crispy-forms master from last week. It's not much more than a POC at the moment, with the current tests passing.
Much work to be done; here are my current thoughts. This won't be a complete list but is enough to be getting on with for now - and probably we can get an inital release out before completing all of them.
EDIT: I've updated the below to split into sections to give some sort of percieved importance. I'll keep this list live for now.
Completed
- [x] Template imports - needs to be `{% load tailwind_field %}`
- [x] Setup GitHub actions for testing, isort, black, flake8
- [x] Include a default rendering option (something like {{ form|crispy }})
- [x] Setup development environment with crispy-test-project
- [x] Add oppinionated rendering to `|crispy`
- [x] Add an example image to README
- [x] code coverage + template coverage? (seems to be a bug with codecov, see PR)
- [x] GH Action - let's try and cache the dependencies to stop pulling all the dependencies every time. e.g. Django get's downloaded 14 times for every pull request that is merged = circa.105mb. Note: cache is 41mb per run (500mb for a merged PR?)
- [x] Docs why are images not showing (do we 'just' need to use RTD?). Note: Img files need to be lower case.
- [x] Should we publish something to PyPI now to get the name?
- [x] Custom objects - e.g. prepend/postpend
- [x] Find out why codecov went missing again. (It's reporting https://codecov.io/gh/django-crispy-forms/crispy-tailwind, but it's not commenting on PRs any more)
- [x] Non form errors (e.g. passwords do not match?)
Sooner ™️
- [ ] Review project strucutre - can someone review how I've setup the licence, setup.py etc?
- [ ] Add more tests for layout
- [ ] Add test for `Field` layout object
- [ ] Docs
- [ ] Fix flake8 - we're running well over on line length. Also why isn't it failing!?
Later
- [ ] What to do about radio / checkbox
- [ ] Put tests into more logical structure.
- [x] Put note on django-crispy-forms that this template pack exists
- [ ] Review to do list items I've left in the code
- [ ] Tidy up code base
- [ ] Review GH Actions - are they running as expected?
- [ ] Refactor field / label class when using crispy filter. (don't need to add classes to tailwind_filters - can we remove this file?!)
Contributor guide
Assessment
This issue has not been assessed yet.