sveetch / cookiecutter-sveetch-djangoapp Goto Github PK

Taken from cookiecutter-sveetch-python 0.4.0 changelog, here is a list of tasks to improve project template. Some of original tasks have been removed (useless) and some few added.

• [cookie] Started this history changelog;
• [cookie] Added _cookiecutter_sveetch_python_version variable to
  cookiecutter.json for versioning template;
• [cookie] Upgraded to cookiecutter>=2.3.0;
• [cookie] Added Makefile task project to create projects in dist/;
• [cookie] Added a new option init_git_repository to enabled for automatic GIT
  repository initialization on created project;
• [cookie] Added a post hook to manage API files removing and GIT initialization
  depending options;
• [cookie] Removed requirement to jinja2-time;
• [template] Fixed project test configuration;
• [template] Removed support for Python 3.6 and 3.7;
• [template] Updated .readthedocs.yml file to follow service deprecations changes;
• [template] Added cookiebaked.json to include used context in created project;
• [template] Defined project_urls option in package setup;
• [template] Removed deprecated encoding file start;
• [template] Fixed command line documentation;
• [template] Upgraded application __init__.py to the modern way to load version;
• [template] Upgraded documentation to a new theme, improved sphinx_reload script and
  moved it into docs/;
• [template] Improved Makefile (better variable names and enabled ANSI color usage on
  task titles);
• [template] Included README in docs/index.rst instead of managing the same content
  twice;
• [template] Don't test all supported Python version in Tox config, only the min and
  max ones;
• [template] Splited extra requirements into various accurate extra spaces (dev,
  quality, release, etc..) to avoid making Tox installing useless stuff (like Flake8)
  for testing;
• [template] Improved flake task to include statistics and running everything (code
  and tests) in a single job;
• [template] Fixed exceptions.py to define class names named from package instead
  of dummy MyApp;

Create repository sveetch-djangoapp-sample and package release for a sample from this cookie template.

When creating a project without Frontend options, some frontend cleaning tasks are still present in Makefile from meta task clean:

• clean-frontend-install
• clean-frontend-build

Makefile should lack of condition around these names in clean task so they don't appear in resulting Makefile without frontend option.

Although there is no really major feature, it should be updated anyway.

At least use Sphinx autodoc extension to list settings.

It will require a little trick in conf.py to load minimal Django settings.

Since we are waiting for cookiecutter 2.x release to leverage support version we are still fixed to 1.7.x, so we should add a note about this on README.

This template is fine to build packaged applications however it could be more useful if it could be able to generate code with absolute path.

Relative import in code makes it not so easy to include generated application code into an existing Django project (when the application code is just copied and pasted into a project tree). It can work for some project but there is many case when it won't and for this, using absolute import path would makes it easier.

It would need two things:

• Rewrite all package relative imports to absolute starting with application module name;
• Optional prefix to add before the application module name for projects which hold their application inside another module instead of being directly defined in sys.path;

So for a package with application name dummy , these relative paths from module dummy/sample.py:

import .foo
from .bar import ping

(so it imports dummy/foo.py and dummy/bar.py)

Would be turned to:

import dummy.foo
from dummy.bar import ping

And if optional prefix project is given it would be turned to:

import project.dummy.foo
from project.dummy.bar import ping

This should be applied to application code since test already used absolute path, however it is the package application absolute path so the prefix would be missing, but it would require a different rewriter to apply, i consider this is not important for now.

Concerns

Relative path may be not so simple to resolve in some cases, it need to be studied.

Alternative

I though some Python would already exists for this kind of import rewriting but it seems not. I searched on isort, something has been thinked in an issue but it is still opened and not implemented.

I've also found a tool like https://github.com/MarcoGorelli/absolufy-imports but it is not maintained anymore, maybe we could at least use some part of its code.

Actually the Makefile from generated package does not include any useful task to create or update PO and MO files from application.

Since README says package will include every useful commands, these tasks should be shipped in Makefile.

As reported from sveetch/cookiecutter-sveetch-python#12

This line has been copied from project-composer and forgotten:

It should be the cookiecutter appropriate variable, can be retrieved from previous file state in repository.