pygalle.core.base.klass

A base class used by the Pygalle framework.


Keywords
pygalle
License
OpenSSL
Install
pip install pygalle.core.base.klass==0.1.3

Documentation

pygalle.core.base.klass


🍎 Warning ! Work in progress...

PyPI Version PyPI Downloads TravisCI Build Status Test Coverage Code Climate Documentation Status License

Table of Contents

Synopsis

Usage

from pygalle.core.base.klass import PygalleBaseClass

# Extends the PygalleBaseClass
class CustomClass(PygalleBaseClass):

    def __init__(self, *args, **kwargs)
      super().__init__(*args, **kwargs)

Installation

pip install pygalle.core.base.klass

API Reference

Please refer to API documentation hosted by Read the Docs.

Tests

Run unit tests

Install package pytest:

pip install pytest

Then run:

pytest

Build

Documentation

Generate README

Be careful! README is generated using templates.

Please only modify documentation from related templates.

Install packages Jinja2 and pynt :

pip install jinja2 pynt

Then you can generate documentation using the following command:

pynt -t .tasks/build.py docs

Generate API documentation

The API documentation is automatically generated using Read the Docs.

Compatibility

Python

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

Thanks to the developers of the very useful dependencies...

History

Please refer to the changelog file.

License

The MIT License

Copyright (c) 2018 SAS 9 FĂ©vrier

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.