Renamed main branch, updated template, implemented pipeline and bumpe…

…d dependencies.

.editorconfig

@@ -1,4 +1,3 @@
-### MANAGED START ###
 # http://editorconfig.org
 
 root = true
@@ -20,5 +19,3 @@ insert_final_newline = false
 
 [Makefile]
 indent_style = tab
-
-### MANAGED STOP ###

.github/workflows/main.yml

@@ -0,0 +1,59 @@
+name: build
+
+on:
+  push:
+    branches: [ 'main' ]
+    tags: [ '*' ]
+  pull_request:
+    branches: [ 'main' ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.10
+
+      - name: Install pipenv
+        run: pip install pipenv
+
+      - name: Lint
+        run: _CI/scripts/lint.py
+
+      - name: Test
+        run: _CI/scripts/test.py
+
+      - name: Build
+        run: _CI/scripts/build.py
+
+  release:
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.10
+
+      - name: Install pipenv
+        run: pip install pipenv
+
+      - name: Upload
+        run: _CI/scripts/upload.py
+
+        env:
+          PYPI_UPLOAD_USERNAME: ${{ secrets.PYPI_UPLOAD_USERNAME }}
+          PYPI_UPLOAD_PASSWORD: ${{ secrets.PYPI_UPLOAD_PASSWORD }}

.gitignore

@@ -1,9 +1,10 @@
-### MANAGED START ###
 # Packages
 *.egg
 *.egg-info
 /dist/
 /build/
+/_build/
+.eggs/
 /eggs/
 /parts/
 /var/
@@ -48,10 +49,16 @@ docs/_build
 
 # VirtualEnv
 env
-env*
+.venv
 
 # Mac
 .DS_Store
 
+# Variables file
+.env
 
-### MANAGED STOP ###
+# pyenv local python version marker
+.python-version
+
+# Visual studio code
+.vscode

.gitlab-ci.yml

@@ -0,0 +1,33 @@
+stages:
+  - lint
+  - test
+  - build
+  - upload
+
+lint:
+  tags: [docker]
+  stage: lint
+  image: IMAGE_WITH_PYTHON37_AND_PIPENV
+  script: _CI/scripts/lint.py
+
+test:
+  tags: [docker]
+  stage: test
+  image: IMAGE_WITH_PYTHON37_AND_PIPENV
+  script: _CI/scripts/test.py
+
+build:
+  tags: [docker]
+  stage: build
+  image: IMAGE_WITH_PYTHON37_AND_PIPENV
+  script: _CI/scripts/build.py
+
+upload:
+  tags: [docker]
+  stage: upload
+  image: IMAGE_WITH_PYTHON37_AND_PIPENV
+  only:
+    - tags
+  except:
+    - branches
+  script: _CI/scripts/upload.py

.prospector.yaml

@@ -1,6 +1,13 @@
 pep257:
   disable:
     - D203
+    - D212
+    - D107
+    - D105
+    - D213
+    - D406
+    - D407
 ignore-paths:
   - _CI
   - build
+  - docs

CONTRIBUTING.rst

@@ -17,22 +17,24 @@ Get Started!
 ------------
 
 Ready to contribute? Here's how to set up `ovchipcardlib` for local development.
+Using of pipenv is highly recommended.
 
 1. Clone your fork locally::
 
-    $ git clone https://github.com/costastf/ovchipcardlib.git
+    $ git clone https://github.com/costastf/ovchipcardlib
 
-2. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your clone for local development::
+2. Install your local copy into a virtualenv. Assuming you have pipenv installed, this is how you set up your clone for local development::
 
-    $ mkvirtualenv ovchipcardlib
     $ cd ovchipcardlib/
-    $ python setup.py develop
+    $ pipenv install --ignore-pipfile
 
 3. Create a branch for local development::
 
     $ git checkout -b name-of-your-bugfix-or-feature
 
    Now you can make your changes locally.
+   Do your development while using the CI capabilities and making sure the code passes lint, test, build and document stages.
+
 
 4. Commit your changes and push your branch to the server::
 

INSTALLATION.rst

@@ -0,0 +1,20 @@
+============
+Installation
+============
+
+At the command line::
+
+    $ pip install ovchipcardlib
+
+Or, if you have virtualenvwrapper installed::
+
+    $ mkvirtualenv ovchipcardlib
+    $ pip install ovchipcardlib
+
+Or, if you are using pipenv::
+
+    $ pipenv install ovchipcardlib
+
+Or, if you are using pipx::
+
+    $ pipx install ovchipcardlib

LICENSE

@@ -1,21 +1,19 @@
-MIT License
+Copyright 2017 Costas Tyfoxylos
 
-Copyright (c) 2017 Costas Tyfoxylos
 
-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:
+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.
+ 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.
+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.

MANIFEST.in

@@ -5,12 +5,14 @@ include HISTORY.rst
 include LICENSE
 include README.rst
 include USAGE.rst
+include Pipfile
+include Pipfile.lock
 include requirements.txt
+include dev-requirements.txt
 include ovchipcardlib/.VERSION
-recursive-include requirements *.txt
-
 
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
 recursive-include docs *.rst conf.py Makefile
+recursive-include ovchipcardlib *

Pipfile

@@ -0,0 +1,27 @@
+[[source]]
+url = "https://pypi.python.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[dev-packages]
+
+flake8 = "==3.8.0"
+sphinx = "~=2.1.2"
+sphinx-rtd-theme = "~=0.4.3"
+prospector = "~=1.3.0"
+coverage = "~=4.5.4"
+nose = "~=1.3.7"
+nose-htmloutput = "~=0.6.0"
+tox = "~=3.13.2"
+betamax = "~=0.8.1"
+betamax-serializers = "~=0.2.1"
+semver = "~=2.8.1"
+gitwrapperlib = "~=0.9.2"
+twine = "~=1.13.0"
+coloredlogs = "~=10.0"
+emoji = "~=0.5.3"
+toml = "~=0.10.0"
+
+[packages]
+
+requests = ">=2.25"