Merge pull request #12 from vroncevic/dev

[flask_func_struct] updated docs & FHW actions

Author: vroncevic

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,10 @@
+Changes/Fixes # .
+
+Changes proposed in this pull requests
+
+-
+
+-
+
+-
+

.github/workflows/flask_func_struct_toc.yml

@@ -0,0 +1,11 @@
+name: TOC Generator flask_func_struct
+on:
+  push:
+    paths:
+      - '**.md'
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/toc-generator@v2

.github/workflows/flask_func_struct_triage.yml

@@ -0,0 +1,16 @@
+name: Triage flask_func_struct
+on:
+  issues:
+    types: [opened]
+jobs:
+  commentOnNewIssues:
+    name: Comment On New Issues
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Comment On New Issues
+        uses: actions/github@v1.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          args: comment "[flask_func_struct] should be supported for Python 2.7, 3.5, 3.6, 3.7, 3.8"

.gitignore

@@ -1,4 +1,3 @@
 __pycache__/
 *.py[cod]
 *$py.class
-.idea

CODE_OF_CONDUCT.md

@@ -0,0 +1,130 @@
+# Contributor Covenant Code of Conduct
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing to flask_func_struct
+
+The following is a set of guidelines for contributing to flask_func_struct and its package, which are hosted in the [flask_func_struct](https://github.com/vroncevic/flask_func_struct) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code of Conduct
+
+flask_func_struct project and everyone participating in it is governed by the [flask_func_struct Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [flask_func_struct](mailto:elektron.ronca@gmail.com).

Dockerfile

@@ -16,16 +16,36 @@
 FROM debian:10
 RUN apt-get update
 RUN DEBIAN_FRONTEND=noninteractive \
- apt-get install -yq --no-install-recommends \
- tree \
- htop \
- python \
- python-pip \
- python-wheel
+    apt-get install -yq --no-install-recommends \
+    vim \
+    nano \
+    tree \
+    htop \
+    wget \
+    unzip \
+    ca-certificates \
+    openssl \
+    python \
+    python-dev \
+    python3 \
+    python3-dev \
+    libyaml-dev
 
-RUN pip install --upgrade setuptools
+RUN wget https://bootstrap.pypa.io/pip/2.7/get-pip.py
+RUN python2 get-pip.py
+RUN python2 -m pip install --upgrade setuptools
+RUN python2 -m pip install --upgrade pip
+RUN python2 -m pip install --upgrade build
+RUN rm -f get-pip.py
+RUN wget https://bootstrap.pypa.io/get-pip.py
+RUN python3 get-pip.py
+RUN python3 -m pip install --upgrade setuptools
+RUN python3 -m pip install --upgrade pip
+RUN python3 -m pip install --upgrade build
+RUN rm -f get-pip.py
 COPY requirements.txt /
-RUN pip install -r requirements.txt
+RUN pip2 install -r requirements.txt
+RUN pip3 install -r requirements.txt
 RUN rm -f requirements.txt
 RUN mkdir /manage_commands/
 COPY manage_commands /manage_commands/

README.md

@@ -4,7 +4,7 @@
 
 **flask_func_struct** is framework for managing Flask App.
 
-Developed in **[python](https://www.python.org/)** code: **100%**.
+Developed in **[python](https://www.python.org/)** code.
 
 The README is used to introduce the modules and provide instructions on
 how to install the modules, any machine dependencies it may have and any
@@ -20,6 +20,7 @@ other information that should be provided before the modules are installed.
 - [Dependencies](#dependencies)
 - [Package structure](#package-structure)
 - [Docs](#docs)
+- [Contributing](#contributing)
 - [Copyright and licence](#copyright-and-licence)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -29,7 +30,8 @@ other information that should be provided before the modules are installed.
 Navigate to **[release page](https://github.com/vroncevic/flask_func_struct/releases)** download and extract release archive.
 
 To install modules type the following
-```
+
+```bash
 tar xvzf flask_func_struct-x.y.z.tar.gz
 cd flask_func_struct-x.y.z/
 pip install -r requirements.txt
@@ -45,7 +47,8 @@ Or You can use docker to create image/container.
 ### Dependencies
 
 **flask_func_struct** requires other modules and libraries (Python 2.x/3.x)
-```
+
+```bash
 * Flask
 * Flask-Migrate
 * Flask-Script
@@ -63,7 +66,8 @@ Or You can use docker to create image/container.
 ### Package structure
 
 Expected framework structure
-```
+
+```bash
 app_server/
 ├── configuration/
 │   ├── database/
@@ -148,6 +152,10 @@ app_server/
 * [flask_func_struct.readthedocs.io](https://flask_func_struct.readthedocs.io/en/latest/)
 * [www.python.org](https://www.python.org/)
 
+### Contributing
+
+[Contributing to config_flask](CONTRIBUTING.md)
+
 ### Copyright and licence
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

_config.yml

@@ -1 +1,4 @@
-theme: jekyll-theme-slate
+theme: jekyll-theme-slate
+markdown: kramdown
+kramdown:
+  parse_block_html: true