wipbox 0.0.14.2

A set of modern Python libraries under development to simplify the execution of reusable routines by different projects.

python-wipbox

A set of modern Python libraries under development to simplify the execution of reusable routines by different projects.

Table of Contents

• Synopsis
• Usage
• Installation
• Build
• Tests
• Développement
• Compatibility
• Issues
• Contributing
• Credits
• Resources
• History
• License

Synopsis

A 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 named deepnox.* is intended to be externalized as part of a specialized Python operating package.

Usage

Installation

Using pip

pip3 install wipbox

Using setup.py

Clone the repository:

git clone https://github.com/deepnox-io/python-wipbox
cd python-wipbox
git checkout main # or any branch, tag or commit...

Install dependencies:

python setup install

# or:
pip install -r requirements.txt

Optional, install dependencies to run unit tests:

pip install -r requirements-cicd.txt

Build

python3 setup.py build

Tests

python3 setup.py test

Code coverage

Coverage.py is required.

To run a code coverage process:

coverage run --omit '*/.venv/*' -m pytest test/ && coverage report -m

Develop

Please install dependencies from files:

• requirements.txt
• requirements-dev.txt
• requirements-cicd.txt

Then install the pre-commit hook to forbidden pushing code if unit tests are not passing.

Issues

Feel free to submit issues and enhancement requests.

Contributing

Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Credits

Thank you very much to this used or integrated open source developments:

Resources

Among 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 tests

• Unit test log output with python

Code quality

• Github Actions for Python Project
• Code formatting: Black
• Documentation formatting: [http://www.pydocstyle.org/en/stable/usage.html]
• isort

CI/CD

• Making a Python package
• Using pre-commit git hooks to automate code checks
• PyTest With GitHub Actions
• GitHub Action: Python Coverage Comment]

History

Please refer to the changelog file.

License

The MIT License

Copyright (c) 2021 Deepnox 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.