diff --git a/.bumpversion.toml b/.bumpversion.toml index 978825e..62cc0de 100644 --- a/.bumpversion.toml +++ b/.bumpversion.toml @@ -1,5 +1,5 @@ [tool.bumpversion] -current_version = "0.2.1" +current_version = "1.0.0" parse = "(?P\\d+)\\.(?P\\d+)\\.(?P\\d+)" serialize = ["{major}.{minor}.{patch}"] search = "{current_version}" diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 6462f0c..63c7836 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,11 @@ Changelog current -------------------- +* + + +1.0.0 (2024-10-31) +-------------------- * Fully rewrite OMI and implement the json schema spec only, remove python class based parsing (#104)[https://github.com/OpenEnergyPlatform/omi/pull/104] * Add a new conversion functionality to convert form v160 to v200 oemetadata [(#111)](https://github.com/rl-institut/super-repo/pull/111) diff --git a/README.rst b/README.rst index 3577151..841b453 100644 --- a/README.rst +++ b/README.rst @@ -37,9 +37,9 @@ Overview :alt: PyPI Package latest release :target: https://pypi.org/project/omi -.. |commits-since| image:: https://img.shields.io/github/commits-since/OpenEnergyPlatform/omi/v0.2.1.svg +.. |commits-since| image:: https://img.shields.io/github/commits-since/OpenEnergyPlatform/omi/v1.0.0.svg :alt: Commits since latest release - :target: https://github.com/OpenEnergyPlatform/omi/compare/v0.2.1...master + :target: https://github.com/OpenEnergyPlatform/omi/compare/v1.0.0...master .. |wheel| image:: https://img.shields.io/pypi/wheel/omi.svg :alt: PyPI Wheel @@ -190,7 +190,7 @@ Module usage:: with open("script/metadata/result_inspection.json", "w", encoding="utf-8") as json_file: json.dump(metadata, json_file, ensure_ascii=False, indent=4) # `indent=4` makes the JSON file easier to read -**Additional Fields ** +**Additional Fields** To be in line with the oemetadata specification we do not allow for additional properties or fields in the metadata. We want to keep the oemetadata relatively lean and readable still linking to other documents or to diff --git a/docs/authors.rst b/docs/authors.rst deleted file mode 100644 index e122f91..0000000 --- a/docs/authors.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../AUTHORS.rst diff --git a/docs/changelog.rst b/docs/changelog.rst deleted file mode 100644 index 565b052..0000000 --- a/docs/changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CHANGELOG.rst diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 7100b12..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -from __future__ import unicode_literals - -import os - - -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.coverage", - "sphinx.ext.doctest", - "sphinx.ext.extlinks", - "sphinx.ext.ifconfig", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", - "sphinx_click.ext", -] - -if os.getenv("SPELLCHECK"): - extensions += ("sphinxcontrib.spelling",) - spelling_show_suggestions = True - spelling_lang = "en_US" - -source_suffix = ".rst" -master_doc = "index" -project = "omi" -year = "2019" -author = "Martin Glauer" -copyright = "{0}, {1}".format(year, author) -version = release = "0.2.1" - -pygments_style = "trac" -templates_path = ["."] -extlinks = { - "issue": ("https://github.com/OpenEnergyPlatform/omi/issues/%structure", "#"), - "pr": ("https://github.com/OpenEnergyPlatform/omi/pull/%structure", "PR #"), -} -# on_rtd is whether we are on readthedocs.org -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only set the theme if we"re building docs locally - html_theme = "sphinx_rtd_theme" - -html_use_smartypants = True -html_last_updated_fmt = "%b %d, %Y" -html_split_index = False -html_sidebars = {"**": ["searchbox.html", "globaltoc.html", "sourcelink.html"]} -html_short_title = "%s-%s" % (project, version) - -napoleon_use_ivar = True -napoleon_use_rtype = False -napoleon_use_param = False diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index e582053..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 40f35b5..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -======== -Contents -======== - -.. toctree:: - :maxdepth: 2 - - readme - installation - usage - reference/index - contributing - authors - changelog - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 3ddbdf9..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,7 +0,0 @@ -============ -Installation -============ - -At the command line:: - - pip install omi diff --git a/docs/readme.rst b/docs/readme.rst deleted file mode 100644 index 72a3355..0000000 --- a/docs/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst diff --git a/docs/reference/index.rst b/docs/reference/index.rst deleted file mode 100644 index 7adef7f..0000000 --- a/docs/reference/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Reference -========= - -.. toctree:: - :glob: - - omi* diff --git a/docs/reference/omi.rst b/docs/reference/omi.rst deleted file mode 100644 index 2ce1117..0000000 --- a/docs/reference/omi.rst +++ /dev/null @@ -1,9 +0,0 @@ -omi -============= - -.. testsetup:: - - from omi import * - -.. automodule:: omi - :members: diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 2c15642..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -sphinx>=1.3 -sphinx-rtd-theme -sphinx-click --e . diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt deleted file mode 100644 index f95eb78..0000000 --- a/docs/spelling_wordlist.txt +++ /dev/null @@ -1,11 +0,0 @@ -builtin -builtins -classmethod -staticmethod -classmethods -staticmethods -args -kwargs -callstack -Changelog -Indices diff --git a/docs/usage.rst b/docs/usage.rst deleted file mode 100644 index 36242ec..0000000 --- a/docs/usage.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _cli: - -===== -Usage -===== - -.. click:: omi.cli:cli - :prog: omi - :show-nested: - -To use omi in a project:: - - import omi diff --git a/pyproject.toml b/pyproject.toml index 02e670d..e58d855 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "omi" -version = "0.2.1" +version = "1.0.0" description = "A library to process and translate open energy metadata." authors = [ "Hendrik Huyskens ", diff --git a/setup.cfg b/setup.cfg index 935dd3a..15556f8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,9 @@ +[bumpversion] +current_version = 1.0.0 + [bdist_wheel] universal = 1 - [flake8] max-line-length = 140 exclude = */migrations/* @@ -9,18 +11,17 @@ exclude = */migrations/* [tool:pytest] testpaths = tests norecursedirs = - migrations - + migrations python_files = - test_*.py - *_test.py - tests.py + test_*.py + *_test.py + tests.py addopts = - -ra - --strict - --doctest-modules - --doctest-glob=\*.rst - --tb=short + -ra + --strict + --doctest-modules + --doctest-glob=\*.rst + --tb=short [isort] force_single_line = True diff --git a/src/omi/__init__.py b/src/omi/__init__.py index 3ced358..5becc17 100644 --- a/src/omi/__init__.py +++ b/src/omi/__init__.py @@ -1 +1 @@ -__version__ = "0.2.1" +__version__ = "1.0.0" diff --git a/tox.ini b/tox.ini index c2957ca..4b495f3 100644 --- a/tox.ini +++ b/tox.ini @@ -55,14 +55,6 @@ deps = sphinxcontrib-spelling pyenchant -[testenv:docs] -deps = - -r{toxinidir}/docs/requirements.txt -commands = - sphinx-build {posargs:-E} -b doctest docs dist/docs - sphinx-build {posargs:-E} -b html docs dist/docs -; sphinx-build -b linkcheck docs dist/docs - [testenv:codecov] deps = codecov