Merge pull request #7 from OpenEnergyPlatform/develop

Make v1.0.1 release

.travis.yml

@@ -0,0 +1,32 @@
+os: linux
+dist: bionic
+language: python
+cache: pip
+jobs:
+  include:
+    - python: "3.6"
+      env:
+        - TOXENV=py36
+    - python: "3.7"
+      env:
+        - TOXENV=py37
+before_install:
+  - python --version
+  - uname -a
+  - lsb_release -a
+  - sudo apt-get update
+install:
+  - pip install -r requirements.txt
+  - virtualenv --version
+  - easy_install --version
+  - pip --version
+  - tox --version
+script:
+  - tox -v
+after_failure:
+  - more .tox/log/* | cat
+  - more .tox/*/log/* | cat
+notifications:
+  email:
+    on_success: never
+    on_failure: always

README.md

@@ -4,14 +4,14 @@
 
 OEP metadata schemata, examples and templates package
 
+[![Build Status](https://travis-ci.org/OpenEnergyPlatform/metadata.svg?branch=develop)](https://travis-ci.org/OpenEnergyPlatform/metadata)
+
 ## License / Copyright
 
-This repository is licensed under [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.en.html)
+This repository is licensed under [MIT License (MIT)](https://spdx.org/licenses/MIT.html)
 
 ## Installation
 
-(Not yet implemented)
-
 `pip install oep-metadata`
 
 ## Usage Examples
@@ -58,4 +58,31 @@ print(METADATA_V140_TEMPLATE)
 
 ### Run tests locally (after above steps):
 
+Short:
+
 `pytest`
+
+Complete:
+
+`tox -v`
+
+### If a Python interpreter version is missing:
+
+Linux (Ubuntu):
+
+```
+sudo add-apt-repository ppa:deadsnakes/ppa
+sudo apt-get update
+# Install only missing interpreters:
+sudo apt-get install python3.6
+sudo apt-get install python3.7
+```
+
+### Make PyPI release:
+
+First bump version in setup.py, then:
+
+```
+python3 setup.py sdist bdist_wheel
+twine upload dist/*
+```

format_code.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+isort -rc ./metadata/ ./tests/
+black *.py metadata/ tests/

requirements.txt

@@ -2,3 +2,6 @@ black
 isort
 jsonschema
 pytest
+tox
+twine
+wheel

setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+license_files = LICENSE

setup.py

@@ -0,0 +1,29 @@
+from os import path
+
+from setuptools import find_packages, setup
+
+here = path.abspath(path.dirname(__file__))
+
+with open(path.join(here, "README.md"), encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="oep-metadata",
+    version="1.0.1",
+    description="Open Energy Platform (OEP) - metadata schemas, examples and templates package",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/OpenEnergyPlatform/metadata",
+    author="Alexis Michaltsis",
+    author_email="[email protected]",
+    license="MIT",
+    classifiers=[
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+    ],
+    keywords="JSON metadata schema open energy platform oep",
+    packages=find_packages(exclude=["tests"]),
+    python_requires=">=3.6",
+)

tox.ini

@@ -0,0 +1,9 @@
+[tox]
+envlist = {py36,py37}
+skipsdist = True
+
+[testenv]
+deps = -r {toxinidir}/requirements.txt
+commands =
+    pytest
+    black --check .