Metadata-Version: 2.1
Name: aedev-setup-project
Version: 0.3.4
Summary: aedev namespace module portion setup_project: project setup helper functions
Home-page: https://gitlab.com/aedev-group/aedev_setup_project
Author: AndiEcker
Author-email: aecker2@gmail.com
License: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Keywords: configuration,development,environment,productivity
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: ae-base
Provides-Extra: dev
Requires-Dist: aedev ; extra == 'dev'
Requires-Dist: aedev-tpl-project ; extra == 'dev'
Requires-Dist: anybadge ; extra == 'dev'
Requires-Dist: coverage-badge ; extra == 'dev'
Requires-Dist: aedev-git-repo-manager ; 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'
Provides-Extra: docs
Provides-Extra: tests
Requires-Dist: anybadge ; extra == 'tests'
Requires-Dist: coverage-badge ; extra == 'tests'
Requires-Dist: aedev-git-repo-manager ; 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'

<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev V0.3.6 -->
<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev_tpl_namespace_root V0.3.5 -->
# setup_project portion of aedev namespace

[![GitLab develop](https://img.shields.io/gitlab/pipeline/aedev-group/aedev_setup_project/develop?logo=python)](
    https://gitlab.com/aedev-group/aedev_setup_project)
[![GitLab release](https://img.shields.io/gitlab/pipeline/aedev-group/aedev_setup_project/release?logo=python)](
    https://gitlab.com/aedev-group/aedev_setup_project/-/tree/release0.3.4)
[![PyPIVersion](https://img.shields.io/pypi/v/aedev_setup_project)](
    https://pypi.org/project/aedev-setup-project/#history)

>aedev namespace module portion setup_project: project setup helper functions.

[![Coverage](https://aedev-group.gitlab.io/aedev_setup_project/coverage.svg)](
    https://aedev-group.gitlab.io/aedev_setup_project/coverage/index.html)
[![MyPyPrecision](https://aedev-group.gitlab.io/aedev_setup_project/mypy.svg)](
    https://aedev-group.gitlab.io/aedev_setup_project/lineprecision.txt)
[![PyLintScore](https://aedev-group.gitlab.io/aedev_setup_project/pylint.svg)](
    https://aedev-group.gitlab.io/aedev_setup_project/pylint.log)

[![PyPIImplementation](https://img.shields.io/pypi/implementation/aedev_setup_project)](
    https://gitlab.com/aedev-group/aedev_setup_project/)
[![PyPIPyVersions](https://img.shields.io/pypi/pyversions/aedev_setup_project)](
    https://gitlab.com/aedev-group/aedev_setup_project/)
[![PyPIWheel](https://img.shields.io/pypi/wheel/aedev_setup_project)](
    https://gitlab.com/aedev-group/aedev_setup_project/)
[![PyPIFormat](https://img.shields.io/pypi/format/aedev_setup_project)](
    https://pypi.org/project/aedev-setup-project/)
[![PyPIStatus](https://img.shields.io/pypi/status/aedev_setup_project)](
    https://libraries.io/pypi/aedev-setup-project)
[![PyPIDownloads](https://img.shields.io/pypi/dm/aedev_setup_project)](
    https://pypi.org/project/aedev-setup-project/#files)


## installation


execute the following command to use the aedev.setup_project module in your application -
it will install aedev.setup_project into your python (virtual) environment:
 
```shell script
pip install aedev-setup-project
```

if you want to contribute to this portion then first fork
[the aedev_setup_project repository at GitLab](
https://gitlab.com/aedev-group/aedev_setup_project "aedev.setup_project code repository").
after that pull it to your machine and finally execute the following command in the root folder of this repository
(aedev_setup_project):

```shell script
pip install -e .[dev]
```

the last command will install this module portion, along with the tools you need
to develop and run tests or to extend the portion documentation. to contribute only to the unit tests or to the
documentation of this portion, replace the setup extras key `dev` in the above command with `tests` or `docs`
respectively.

more detailed explanations on how to contribute to this project
[are available here](https://gitlab.com/aedev-group/aedev_setup_project/-/blob/develop/CONTRIBUTING.rst)


## namespace portion documentation

information on the features and usage of this portion are available at
[ReadTheDocs](
https://aedev.readthedocs.io/en/latest/_autosummary/aedev.setup_project.html#module-aedev.setup_project
"aedev_setup_project documentation").


