🍎 Warning ! Work in progress...
Table of Contents
- API Reference
from pygalle.core.base.klass import PygalleBaseClass # Extends the PygalleBaseClass class CustomClass(PygalleBaseClass): def __init__(self, *args, **kwargs) super().__init__(*args, **kwargs)
pip install pygalle.core.base.klass
Install package pytest:
pip install pytest
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
Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
Thanks to the developers of the very useful dependencies...
- shortid by corpix, Copyright (c) 2014 Dmitry Moskowski email@example.com, MIT License.
- DotMap by drgrib, Copyright (c) 2015 Chris Redford, 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.