aedev-aedev

aedev namespace-root project

aedev namespace-root: aedev namespace root, providing setup, development and documentation tools/templates for Python projects.

aedev namespace root package use-cases

this package is the root project of the aedev namespace and their portions (the modules and packages belonging to the namespace aedev). it provides helpers and templates in order to bundle and ease the maintenance, for example to:

• update and deploy managed files created and renewed from template files.
• merge docstrings of all portions into a single combined and cross-linked documentation.
• compile and publish documentation via Sphinx onto ReadTheDocs.
• bulk manage/update/refactor multiple portion projects of this namespace simultaneously using the git repository manager tool (pjm).

to enable the update and deployment of managed files generated from the templates provided by this root package, add this root package to the development requirements file (dev_requirements.txt) of each portion project of this namespace. in this entry you can optionally specify the version of this project.

and because this namespace-root package is only needed for development tasks, it will never need to be added to the installation requirements file (requirements.txt) of a namespace portion project.

please check the project manager manual for more detailed information on the provided actions of the pjm tool.

installation

no installation is needed to use this project for your portion projects, because the pjm tool is automatically fetching this and the other template projects from https://gitlab.com/aedev-group (and in the specified version).

an installation is only needed if you want to adapt this namespace-root project for your needs or if you want to contribute to this root package. in this case please follow the instructions given in the :ref:contributing document.

namespace portions

the following 7 portions are currently included in this namespace:

• aedev_base
• aedev_commands
• aedev_project_vars
• aedev_project_manager
• aedev_app_tpls
• aedev_project_tpls
• aedev_namespace_root_tpls