Merge pull request #48 from oemof/v0.5

* Improved code quality
* Add Entity.custom_properties
* Simplify node access (experimental: energy_system.node[label])
* Make keyword arguments explicit

.github/workflows/tox_pytests.yml

@@ -6,9 +6,7 @@ on:
       - master
       - dev
   pull_request:
-    branches:
-      - master
-      - dev
+
   workflow_dispatch:
   schedule:
     - cron: "0 5 * * 6"  # 5:00 UTC every Saturday
@@ -18,14 +16,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: [3.8, 3.9, "3.10"]
 
     steps:
     - uses: actions/checkout@v1
     - name: Install xmllint
       run: sudo apt install coinor-cbc
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.gitignore

@@ -46,6 +46,7 @@ htmlcov
 .idea
 *.iml
 *.komodoproject
+.vscode
 
 # Complexity
 output/*.html

.pep8speaks.yml

@@ -0,0 +1,11 @@
+# File : .pep8speaks.yml
+
+scanner:
+    diff_only: True
+    linter: pycodestyle  # Other option is flake8
+
+pycodestyle:  # Same as scanner.linter value.
+    max-line-length: 79  # Default in PEP 8
+    ignore:  # Errors and warnings to ignore
+        - W503  # line break before binary operator
+        - E203

CHANGELOG.rst

@@ -15,3 +15,10 @@ Changelog
 * Improved testing
 * Explicitly defined API
 
+
+0.5.0
+-----
+
+* Improved code quality
+* Add Entity.custom_properties
+* Simplify node access (experimental: energy_system.node[label])

CONTRIBUTING.rst

@@ -49,7 +49,7 @@ To set up `oemof.network` for local development:
 
    Now you can make your changes locally.
 
-4. When you're done making changes run all the checks and docs builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ one command::
+4. When you're done making changes run all the checks and docs builder with `tox <https://tox.wiki/en/latest/installation.html>`_ one command::
 
     tox
 

MANIFEST.in

@@ -10,6 +10,7 @@ include .editorconfig
 
 include AUTHORS.rst
 include CHANGELOG.rst
+include CITATION.cff
 include CONTRIBUTING.rst
 include LICENSE
 include README.rst
@@ -18,6 +19,7 @@ recursive-include docs *.rst
 recursive-include tests *.py
 
 
-include tox.ini .travis.yml .appveyor.yml .readthedocs.yml
+include tox.ini
+include *.yml
 
 global-exclude *.py[cod] __pycache__/* *.so *.dylib *.swp

README.rst

@@ -29,16 +29,12 @@ Overview
     :target: https://readthedocs.org/projects/oemof-network
     :alt: Documentation Status
 
-.. |travis| image:: https://api.travis-ci.org/oemof/oemof-network.svg?branch=master
-    :alt: Travis-CI Build Status
-    :target: https://travis-ci.org/oemof/oemof-network
-
 .. |coveralls| image:: https://coveralls.io/repos/oemof/oemof-network/badge.svg?branch=dev&service=github
     :alt: Coverage Status
     :target: https://coveralls.io/r/oemof/oemof-network?branch=dev
 
 .. |codacy| image:: https://api.codacy.com/project/badge/Grade/39b648d0de3340da912c3dc48688a7b5
-    :target: https://www.codacy.com/gh/oemof/oemof-network?utm_source=github.com&utm_medium=referral&utm_content=oemof/oemof.network&utm_campaign=Badge_Grade
+    :target: https://app.codacy.com/gh/oemof/oemof-network
     :alt: Codacy Code Quality Status
 
 .. |codeclimate| image:: https://codeclimate.com/github/oemof/oemof-network/badges/gpa.svg

ci/templates/tox.ini

@@ -40,7 +40,7 @@ deps =
     isort
 skip_install = true
 commands =
-    python setup.py check --strict --metadata --restructuredtext
+    python setup.py check --strict-markers --metadata --restructuredtext
     check-manifest {toxinidir}
     flake8 src tests setup.py
     isort --verbose --check-only --diff --recursive src tests setup.py

docs/conf.py

@@ -17,16 +17,16 @@
 source_suffix = ".rst"
 master_doc = "index"
 project = "oemof.network"
-year = "2020"
-author = "Stephan Günther"
+year = "2023"
+author = "oemof developer group"
 copyright = "{0}, {1}".format(year, author)
-version = release = "0.4.0"
+version = release = "0.5.0"
 
 pygments_style = "trac"
 templates_path = ["."]
 extlinks = {
-    "issue": ("https://github.com/oemof/oemof.network/issues/%s", "#"),
-    "pr": ("https://github.com/oemof/oemof.network/pull/%s", "PR #"),
+    "issue": ("https://github.com/oemof/oemof-network/issues/%s", "#%s"),
+    "pr": ("https://github.com/oemof/oemof-network/pull/%s", "PR #%s"),
 }
 # on_rtd is whether we are on readthedocs.org
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"

setup.cfg

@@ -46,7 +46,7 @@ python_files =
 
 addopts =
     -ra
-    --strict
+    --strict-markers
     --ignore=docs/conf.py
     --ignore=setup.py
     --ignore=ci

setup.py

@@ -32,7 +32,7 @@ def read(*names, **kwargs):
 
 setup(
     name="oemof.network",
-    version="0.4.0",
+    version="0.5.0",
     license="MIT",
     description="The network/graph submodules of oemof.",
     long_description=long_description,
@@ -77,7 +77,7 @@ def read(*names, **kwargs):
         # eg: 'keyword1', 'keyword2', 'keyword3',
     ],
     python_requires=">=3.7",
-    install_requires=["pandas", "blinker", "dill", "networkx"],
+    install_requires=["pandas", "blinker", "dill", "networkx", "oemof.tools"],
     extras_require={
         "dev": ["pytest"],
         # eg:

src/oemof/network/__init__.py

@@ -1,24 +1,28 @@
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 
 from . import energy_system
 from . import graph
 from . import groupings
 from . import network
-from .network import (
-    Bus,
-    Component,
-    Sink,
-    Source,
-    Transformer,
-)
+from .network import Bus
+from .network import Component
+from .network import Edge
+from .network import Entity
+from .network import Node
+from .network import Sink
+from .network import Source
+from .network import Transformer
 
 __all__ = [
     "Bus",
     "Component",
+    "Edge",
+    "Entity",
     "energy_system",
     "graph",
     "groupings",
     "network",
+    "Node",
     "Sink",
     "Source",
     "Transformer",