Release 0.9.0

Author: Thomas Offergeld

.gitlab-ci.yml

@@ -1,7 +1,3 @@
-image: docker:git
-services:
-- docker:dind
-
 stages:
 - build
 - verify
@@ -10,6 +6,7 @@ stages:
 - deploy:build
 - deploy:check
 - deploy:upload
+- deploy:doc
 - doc
 
 variables:
@@ -24,6 +21,7 @@ variables:
   PYPI_PASSWORD: $PYPI_PASSWORD
 
 build:
+  # Build an image with all requirements installed to use in later stages
   tags:
     - linux
   stage: build
@@ -40,24 +38,15 @@ build:
   except:
     - Releases
 
-pytest:
-  extends: .test
-  stage: test:unit
-  script:
-    - pytest --ignore=cimpyorm/Test/Integration --ignore=cimpyorm/Test/Deployment --junitxml=pytest.xml --cov
-  coverage: '/TOTAL.+ ([0-9]{1,3}%)/'
-  artifacts:
-    when: always
-    reports:
-      junit: pytest.xml
-
 pylint:
+  # Run a static code style checker (pylint)
   extends: .test
   stage: verify
   script:
     - ./pylint.sh
 
 bandit:
+  # Run a static vulnerability checker (Bandit)
   extends: .test
   stage: verify
   allow_failure: true
@@ -69,57 +58,64 @@ bandit:
     expose_as: "Bandit"
     paths: [report.html]
 
+pytest:
+  # Run unit tests, skipping some more special test cases (Integration, Deployment)
+  extends: .test
+  image: python:${PY_VERSION}
+  stage: test:unit
+  script:
+    - pip install -r requirements.txt
+    - pip install -r dev-requirements.txt
+    - pytest --ignore=cimpyorm/Test/Integration --ignore=cimpyorm/Test/Deployment --junitxml=pytest.xml --cov
+  coverage: '/TOTAL.+ ([0-9]{1,3}%)/'
+  needs: ["build"]
+  artifacts:
+    when: always
+    reports:
+      junit: pytest.xml
+  parallel:
+    matrix:
+      - PY_VERSION: ["3.7", "3.8"]
+        DUMMY: "0"
+
 .integration:
+  # Anchor for integration tests - retried once (sometimes services don't startup properly) and
+  # only run on Dev branch
   tags:
     - docker
   image: $CONTAINER_TEST_IMAGE
   stage: test:integration
+  needs: ["build"]
   retry: 1
   only:
     - Dev
 
 integration:SQLite:
+  # Test with SQLite Backend
   extends: .integration
   script:
     - pytest --maxfail=1 cimpyorm/Test/Integration/SQLite
 
-pages:
-  stage: doc
-  only:
-    - Releases
-  tags:
-    - docker
-  image: $CONTAINER_TEST_IMAGE
-  script:
-    - cd docs
-    - make html
-    - cd ..
-    - mkdir public
-    - mv docs/_build/html/* public
-  artifacts:
-    paths:
-    - public
-
-.deploy_common:
+.deploy:
   only:
     - Releases
   tags:
     - docker
   image: python
 
 build_dist:
-  extends: .deploy_common
+  extends: .deploy
   stage: deploy:build
   script:
-    - pip install poetry
-    - poetry build
+    - pip install --upgrade setuptools wheel
+    - python setup.py sdist bdist_wheel
   artifacts:
-    when: on_success
-    expire_in: 1 week
     paths:
-      - dist
+      - dist/
+
 
 check:
+  # Show contents of build archive (for manual inspection)
   only:
     - Releases
   tags:
@@ -132,15 +128,43 @@ check:
   dependencies:
     - build_dist
 
-upload:
-  extends: .deploy_common
+release:pypi:
+  # Release on pypi using twine and the variable-defined credentials
+  extends: .deploy
   stage: deploy:upload
+  needs: ["build_dist"]
   when: manual
   allow_failure: true
   script:
-    - pip install -q twine toml requests pytest
+    - pip install -q twine toml requests pytest pandas
     - twine upload --repository-url $PYPI_ENDPOINT --u $PYPI_USER --p $PYPI_PASSWORD dist/*
     - sleep 20
     - pytest cimpyorm/Test/Deployment
   dependencies:
     - build_dist
+    
+release:gitlab:
+  extends: .deploy
+  stage: deploy:upload
+  needs: ["build_dist"]
+  when: manual
+  script:
+    - pip install -q twine
+    - TWINE_PASSWORD=${GITLAB_PACKAGE_KEY} TWINE_USERNAME=package-token python -m twine upload --verbose --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
+
+doc:
+  # Create PDF documentation
+  tags:
+    - docker
+  image: $CI_REGISTRY/iaew/docker/python-texlive:3.7
+  stage: deploy:doc
+  script:
+    - pip install sphinx sphinx-autodoc-typehints sphinx_rtd_theme
+    - sphinx-build -b latex docs/ Documentation
+    - cd Documentation && make
+  artifacts:
+    when: on_success
+    expire_in: 1 week
+    paths:
+      - Documentation/cimpyorm.pdf
+  needs: []

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7
+FROM python:3.8
 
 COPY requirements.txt dev-requirements.txt /
 RUN pip install -r requirements.txt &&\
@@ -8,4 +8,4 @@ COPY . /app
 
 RUN pip install /app/
 
-WORKDIR app
+WORKDIR app

LICENSE

@@ -1,6 +1,7 @@
 BSD 3-Clause License
 
-Copyright (c) 2018, Thomas Offergeld, Institute for High Voltage Technology, RWTH Aachen University
+Copyright (c) 2018-2019, Thomas Offergeld, Institute for High Voltage Technology, RWTH Aachen University
+Copyright (c) 2019-2021, Thomas Offergeld, High Voltage Equipment and Grids, Digitalization and Energy Economics, RWTH Aachen University
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -43,4 +43,4 @@ names_of_ConductingEquipment = [t.ConductingEquipment.name for t in all_terminal
 
 ---
 ## Bug reports/feature requests
-Please use the Issue Tracker.
+Please use the Issue Tracker.

cimpyorm/Test/test_parser.py

@@ -16,6 +16,9 @@
 from cimpyorm import parse, backends
 from cimpyorm.Test import test_datasets
 
+from cimpyorm import parse, backends
+from cimpyorm.Test import test_datasets
+
 from defusedxml.lxml import fromstring
 
 def test_single_object(cgmes_schema):

dev-requirements.txt

@@ -5,4 +5,4 @@ sphinx_rtd_theme
 sphinx-autodoc-typehints
 toml
 pytest
-pytest-cov
+pytest-cov

docs/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'CIMPyORM'
-copyright = '2018-2019 IfHT at RWTH Aachen University, 2019-2020 IAEW at RWTH Aachen University'
+copyright = '2018-2019 IfHT at RWTH Aachen University, 2019-2021 IAEW at RWTH Aachen University'
 author = 'Thomas Offergeld'
 
 try:

pyproject.toml

@@ -7,4 +7,4 @@ pandas
 tabulate
 tqdm
 click
-defusedxml < 0.7
+defusedxml < 0.7

requirements.txt

@@ -27,14 +27,14 @@
     name='cimpyorm',  # Required
     # https://www.python.org/dev/peps/pep-0440/
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='0.8.4',  # Required
+    version='0.9.0',  # Required
     # https://packaging.python.org/specifications/core-metadata/#summary
     description="A database-backed ORM for CIM datasets.",  # Required
     # https://packaging.python.org/specifications/core-metadata/#description-optional
     long_description=long_description,  # Optional
     # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
     long_description_content_type='text/markdown',  # Optional (see note above)
-    url="http://www.ifht.rwth-aachen.de",  # Optional
+    url="http://www.iaew.rwth-aachen.de",  # Optional
     author="Thomas Offergeld",  # Optional
     author_email="t.offergeld@iaew.rwth-aachen.de",  # Optional
     # For a list of valid classifiers, see https://pypi.org/classifiers/
@@ -44,8 +44,8 @@
         'License :: OSI Approved :: BSD License', 'Natural Language :: English',
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7'
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8'
     ],  # Optional
     packages=find_packages(exclude=[
         'cimpyorm/Test/Deployment/**',
@@ -54,13 +54,12 @@
     # https://packaging.python.org/en/latest/requirements.html
     install_requires=[
         'Click',
-        'sqlalchemy (>=1.2,<2.0)',
-        'networkx (>=2.2,<3.0)',
-        'numpy (>=1.15,<2.0)',
-        'lxml (>=4.2,<5.0)',
-        'pytest (>=4.0,<5.0)',
-        'pandas (>=0.24.1,<0.25.0)',
-        'tabulate (>=0.8.3,<0.9.0)',
+        'sqlalchemy',
+        'networkx',
+        'numpy',
+        'lxml',
+        'pandas',
+        'tabulate',
         'tqdm',
         'defusedxml (<0.7.0)'
     ],  # Optional
@@ -71,7 +70,7 @@
     include_package_data=True,
     # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
     project_urls={  # Optional
-        'homepage': 'http://www.ifht.rwth-aachen.de',
+        'homepage': 'http://www.iaew.rwth-aachen.de',
     },
     entry_points='''
     [console_scripts]