Metadata-Version: 2.4
Name: aedev_aedev
Version: 0.3.31
Summary: aedev namespace-root: aedev namespace root, providing setup, development and documentation tools/templates for Python projects.
Home-page: https://gitlab.com/aedev-group/aedev_aedev
Author: AndiEcker
Author-email: aecker2@gmail.com
License: GPL-3.0-or-later
Project-URL: Bug Tracker, https://gitlab.com/aedev-group/aedev_aedev/-/issues
Project-URL: Documentation, https://aedev.readthedocs.io/en/latest/_autosummary/aedev.aedev.html
Project-URL: Repository, https://gitlab.com/aedev-group/aedev_aedev
Project-URL: Source, https://aedev.readthedocs.io/en/latest/_modules/aedev/aedev.html
Keywords: configuration,development,environment,productivity
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Provides-Extra: dev
Requires-Dist: aedev_project_tpls; extra == "dev"
Requires-Dist: aedev_app_tpls; extra == "dev"
Requires-Dist: aedev_namespace_root_tpls; extra == "dev"
Requires-Dist: aedev_base; extra == "dev"
Requires-Dist: aedev_commands; extra == "dev"
Requires-Dist: aedev_project_vars; extra == "dev"
Requires-Dist: aedev_project_manager; extra == "dev"
Requires-Dist: aedev_aedev; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: sphinx_autodoc_typehints; extra == "dev"
Requires-Dist: sphinx_paramlinks; extra == "dev"
Requires-Dist: aedev_project_vars; extra == "dev"
Requires-Dist: anybadge; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-django; extra == "dev"
Requires-Dist: typing; extra == "dev"
Requires-Dist: types-setuptools; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
Requires-Dist: sphinx_paramlinks; extra == "docs"
Requires-Dist: aedev_project_vars; extra == "docs"
Provides-Extra: tests
Requires-Dist: anybadge; extra == "tests"
Requires-Dist: flake8; extra == "tests"
Requires-Dist: mypy; extra == "tests"
Requires-Dist: pylint; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-django; extra == "tests"
Requires-Dist: typing; extra == "tests"
Requires-Dist: types-setuptools; extra == "tests"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-python
Dynamic: summary

<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.26 -->
# __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](https://aedev.readthedocs.io "aedev on RTD").
* bulk manage/update/refactor multiple portion projects of this namespace simultaneously using the
  [git repository manager tool (__pjm__)](https://gitlab.com/aedev-group/aedev_project_manager).

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](
https://aedev.readthedocs.io/en/latest/man/project_manager.html "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_project_tpls](https://pypi.org/project/aedev_project_tpls "aedev namespace portion aedev_project_tpls")
* [aedev_app_tpls](https://pypi.org/project/aedev_app_tpls "aedev namespace portion aedev_app_tpls")
* [aedev_namespace_root_tpls](https://pypi.org/project/aedev_namespace_root_tpls "aedev namespace portion aedev_namespace_root_tpls")
* [aedev_base](https://pypi.org/project/aedev_base "aedev namespace portion aedev_base")
* [aedev_commands](https://pypi.org/project/aedev_commands "aedev namespace portion aedev_commands")
* [aedev_project_vars](https://pypi.org/project/aedev_project_vars "aedev namespace portion aedev_project_vars")
* [aedev_project_manager](https://pypi.org/project/aedev_project_manager "aedev namespace portion aedev_project_manager")
