Package: vangap-meliora
Python Project TemplateThis project follows the Python Standards declared inPEP 621.
This uses a pyproject.yaml to configuration the project. In this example,flitis used to simplify the build process, and publish to pypi.Project Organization.devcontainer - This directory contains required files for creating aCodespace..githubworkflows - Contains GitHub Actions used for building, testing and publishing.publish-test.yml - Publish wheels tohttps://test.pypi.org/publish.yml - Publish wheels tohttps://pypi.org/pull-request.yml - Build and Test pull requests before commiting to main.template-sync.yml - Update GitHub Repo with enhancments to base templatedocs - collect documents (default format .md)src - place new source code herepython_package - sample package (this can be deleted when creating a new repository)tests - contains Python based test cases to validation src code.pre-commit-config.yaml - Contains various pre-check fixes for Python.templateversionrc - used to track template version usage.MANIFEST.in - Declares additional files to include in Python whlpyproject.toml - Python Project Declarationws.code-workspace - Recommended configurations forVisual Studio Codepyproject.tomlThe following sections are defined in the configuration toml.build-systemprojectoptional-dependenciesurlstoolbanditcoveragerunreportpyrightpytesttoxpylintMESSAGES CONTROLREPORTSREFACTORINGBASICFORMATLOGGINGMISCELLANEOUSSIMILARITIESSPELLINGSTRINGTYPECHECKVARIABLESCLASSESDESIGNIMPORTSEXCEPTIONSbuild-systemTODO: add info on flit configurationprojectThis section defines the project metadata, which may have been previously contained in a setup.py file.optional-dependenciesThis are otpimal dependancey groups that can be installed via 'pip install .[tests]'.
One group is included for dependancies required for testing. A second group is included for PySpark based dependancies.toolThis section defines the configurations for additional tools used to format, lint, type-check, and analysis Python code.banditPerforms Security Static Analysis checks on code base.blackAuto-formats codecoverageConfigures code coverage reports generatated during testing.pyrightPerforms static type checking on Python.pytestConfigures various test markers used during testing.pylintPerforms Linting and Static Analysis. Any modifictions made by the auto-formater (black) are always considered correct.Publish to PyPi from GitHubIn order to publish to PyPi, a repostirory secret must be created, "PYPI_PASSWORD". In order to publish to the Test PyPi, a second secret must be added, "TEST_PYPI_PASSWORD".ContributingThis project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visithttps://cla.opensource.microsoft.com.When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.This project has adopted theMicrosoft Open Source Code of Conduct.
For more information see theCode of Conduct FAQor
contactopencode@microsoft.comwith any additional questions or comments.TrademarksThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must followMicrosoft's Trademark & Brand Guidelines.
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.