Refactor sloc scanner to be a class

.asf.yaml

@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-# https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
+# https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features
 ---
 github:
   description: "Apache Kibble - a tool to collect, aggregate and visualize data about any software project"

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
 name: Feature request
-about: Idea or feature request  
+about: Idea or feature request
 title: ''
 labels: 'kind:feature'
 assignees: ''

.github/labeler.yml

@@ -0,0 +1,23 @@
+area:api:
+  - 'kibble/api/*'
+
+area:cli:
+  - 'kibble/cli/*'
+
+area:scanners:
+  - 'kibble/scanners/*'
+
+area:ui:
+  - 'ui/*'
+
+area:docs:
+  - 'docs/*'
+  - '*.md'
+
+area:dev:
+  - '.github/*'
+  - '.pre-commit.config.yaml'
+  - 'asf.yaml'
+  - 'Dockerfile*'
+  - 'docker*'
+  - 'setup.*'

.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+---
+name: CI
+on:
+  - push
+  - pull_request
+
+jobs:
+  statics:
+    name: Static checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]
+        with:
+          extra_args: --show-diff-on-failure
+  build-docker:
+    name: Build kibble dev image
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build docker image
+        run: docker-compose -f docker-compose-dev.yaml build setup
+      - name: Run kibble command
+        run: docker run apache/kibble kibble --help
+      - name: Check dependencies
+        run: docker run apache/kibble pip check
+  run-tests:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - run: pip install '.[devel]'
+      - run: pytest tests --color=yes

.github/workflows/labeler.yaml

@@ -0,0 +1,12 @@
+name: "PR labeler"
+on:
+  - pull_request_target
+
+jobs:
+  triage:
+    name: Label
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@main
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -1,5 +1,6 @@
 # Apache Kibble files
-api/yaml/kibble.yaml
+api/yaml/kibble.yaml*
+kibble/api/yaml/kibble.yaml*
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.pre-commit-config.yaml

@@ -24,8 +24,60 @@ minimum_pre_commit_version: "1.20.0"
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v3.3.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
+        exclude: ^ui/vendors/.*$
       - id: trailing-whitespace
+        exclude: ^ui/vendors/.*$
+      - id: fix-encoding-pragma
+        args:
+          - --remove
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.1.9
+    hooks:
+      - id: insert-license
+        name: Add license for all other files
+        exclude: ^\.github/.*$
+        args:
+          - --comment-style
+          - "|#|"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+        files: >
+          \.cfg$|^Dockerfile.*$|\.sh$|\.bash$|\.py$|\.yml$|\.yaml$
+      - id: insert-license
+        name: Add license for all rst files
+        exclude: ^\.github/.*$
+        args:
+          - --comment-style
+          - "||"
+          - --license-filepath
+          - license-templates/LICENSE.rst
+          - --fuzzy-match-generates-todo
+        files: \.rst$
+      - id: insert-license
+        name: Add license for all md and html files
+        files: \.md$|\.html$
+        exclude: ^\.github/.*$|
+        args:
+          - --comment-style
+          - "<!--|| -->"
+          - --license-filepath
+          - license-templates/LICENSE.txt
+          - --fuzzy-match-generates-todo
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    - id: black
+      name: Black
+      types: [python]
+  - repo: https://github.com/timothycrosley/isort
+    rev: 5.6.4
+    hooks:
+      - id: isort
+        name: Run isort to sort imports
+        args: ['--multi-line', '3', '--trailing-comma']
+        files: \.py$

CODE_OF_CONDUCT.md

@@ -1,7 +1,7 @@
 # Code of Conduct
 
-The Apache Kibble project follows the 
+The Apache Kibble project follows the
 [Apache Software Foundation code of conduct](https://www.apache.org/foundation/policies/conduct.html).
 
-If you observe behavior that violates those rules please follow the 
+If you observe behavior that violates those rules please follow the
 [ASF reporting guidelines](https://www.apache.org/foundation/policies/conduct#reporting-guidelines).

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Kibble #
 
-## Community 
+## Community
 
 The main development and design discussion happens on our mailing lists.
 We have a list specifically for development, and one for future user questions and feedback.
@@ -15,5 +15,57 @@ We also have:
 
 ## Development installation
 
-This project requires Python in higher version than 3.3.
-More information will come soon!
+You should be able to install Apache Kibble by simply doing:
+```
+pip install -e ."[devel]"
+```
+
+The easiest option to spin up a development environment is to use our development docker-compose.
+The development image has mounted all Kibble sources so all your local code changes will be automatically
+reflected  in the running app.
+
+First you need to configure the Elasticsearch node:
+```
+docker-compose -f docker-compose-dev.yaml up setup
+```
+Once you see the
+```
+setup_1          | All done, Kibble should...work now :)
+```
+Now you can can launch Apache Kibble ui:
+```
+docker-compose -f docker-compose-dev.yaml up ui
+```
+The ui should be available under `http://0.0.0.0:8000` or `http://localhost:8000`. To log in you can use
+the dummy admin account `admin@kibble` and password `kibbleAdmin`.
+
+You can also start only the API server:
+```
+docker-compose -f docker-compose-dev.yaml up kibble
+```
+
+## Code Quality
+
+Apache Kibble project is using [pre-commits](https://pre-commit.com) to ensure the quality of the code.
+We encourage you to use pre-commits, but it's not required in order to contribute. Every change is checked
+on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then
+you should install Python3.6 or newer together and run:
+```bash
+pip install pre-commit
+# or
+brew install pre-commit
+```
+For more installation options visit the [pre-commits](https://pre-commit.com).
+
+To turn on pre-commit checks for commit operations in git, run:
+```bash
+pre-commit install
+```
+To run all checks on your staged files, run:
+```bash
+pre-commit run
+```
+To run all checks on all files, run:
+```bash
+pre-commit run --all-files
+```

Dockerfile.dev

@@ -0,0 +1,29 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+FROM python:3.8-slim
+
+USER root
+RUN apt-get update
+RUN apt-get install -y gcc git unzip cloc
+
+COPY . /kibble/
+
+WORKDIR /kibble
+
+RUN pip install --upgrade pip
+RUN pip install -e .

NOTICE

@@ -119,7 +119,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 Metis Dashboard (MIT License)
 ------------------------------------------------------------------------
 
-Copyright (c) 2015 onokumus 
+Copyright (c) 2015 onokumus
 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
@@ -187,3 +187,29 @@ 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.
 
+
+------------------------------------------------------------------------
+Loguru (MIT License)
+------------------------------------------------------------------------
+
+MIT License
+
+Copyright (c) 2017
+
+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.

README.md

@@ -1,14 +1,16 @@
 <p align="center"><img src="/ui/images/kibble-logo.png" width="300"/></p>
 
 # Apache Kibble
+![CI](https://github.com/apache/kibble/workflows/CI/badge.svg)
+[![License](http://img.shields.io/:license-Apache%202-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
 
 Apache Kibble is a tool to collect, aggregate and visualize data about any software project that uses commonly known tools. It consists of two components:
 
 - **Kibble Server** (this repository) - main database and UI Server. It serves as the hub
  for the scanners to connect to, and provides the overall management of sources as well as the
  visualizations and API end points.
 - **Kibble scanners** ([kibble-scanners](https://github.com/apache/kibble-scanners)) - a collection of
- scanning applications each designed to work with a specific type of resource (git repo, mailing list, 
+ scanning applications each designed to work with a specific type of resource (git repo, mailing list,
  JIRA, etc) and push compiled data objects to the Kibble Server.
 
 ## Documentation