Package: wipbox
python-wipboxA set of modern Python libraries under development to simplify the execution of reusable routines by different projects.Table of ContentsSynopsisUsageInstallationBuildTestsDéveloppementCompatibilityIssuesContributingCreditsResourcesHistoryLicenseSynopsisA set of modern Python libraries under development to simplify the execution of reusable routines by different projects.Each namespace is intended to become a separate library, subject to validation of its quality level.Each of the namespaces nameddeepnox.*is intended to be externalized as part of a specialized Python operating package.UsageInstallationUsingpippip3installwipboxUsingsetup.pyClone the repository:gitclonehttps://github.com/deepnox-io/python-wipboxcdpython-wipbox
gitcheckoutmain# or any branch, tag or commit...Install dependencies:pythonsetupinstall# or:pipinstall-rrequirements.txtOptional, install dependencies to run unit tests:pipinstall-rrequirements-cicd.txtBuildpython3setup.pybuildTestspython3setup.pytestCode coverageCoverage.pyis required.To run a code coverage process:coveragerun--omit'*/.venv/*'-mpytesttest/&&coveragereport-mDevelopPlease install dependencies from files:requirements.txtrequirements-dev.txtrequirements-cicd.txtThen install thepre-commithook to forbidden pushing code if unit tests are not passing.IssuesFeel free tosubmit issuesand enhancement requests.ContributingPlease refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.Forkthe repo on GitHubClonethe project to your own machineCommitchanges to your own branchPushyour work back up to your forkSubmit aPull requestso that we can review your changesNOTE: Be sure to merge the latest from "upstream" before making a pull request!CreditsThank you very much to this used or integrated open source developments:ResourcesAmong others, to carry out this large and infinite project, we made use, among many others, of the following documentary resources.Thank you to their authors for sharing their knowledge with our team.Unit testsUnit test log output with pythonCode qualityGithub Actions for Python ProjectCode formatting:BlackDocumentation formatting: [http://www.pydocstyle.org/en/stable/usage.html]isortCI/CDMaking a Python packageUsing pre-commit git hooks to automate code checksPyTest With GitHub ActionsGitHub Action: Python Coverage Comment]HistoryPlease refer tothe changelog file.LicenseThe MIT LicenseCopyright (c) 2021Deepnox SAS, Paris, France.Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.