v0.2.1

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+# New Features
+
+* tbd
+
+# Changes
+
+* tbd
+
+# Bug Fixes
+
+* tbd

.gitignore

@@ -8,3 +8,6 @@ doc/_theme
 
 # PyCharm project
 /.idea/workspace.xml
+
+# VSCode settings
+/.vscode

Test.py

@@ -29,11 +29,11 @@
 #
 from pathlib import Path
 
-from pyIPXACT           import Vlnv
-from pyIPXACT.Catalog   import Catalog, IpxactFile
-from pyIPXACT.Component import Component
-from pyIPXACT.Design    import Design
-from pyIPXACT.DesignConfiguration import DesignConfiguration
+from pyEDAA.IPXACT           import Vlnv
+from pyEDAA.IPXACT.Catalog   import Catalog, IpxactFile
+from pyEDAA.IPXACT.Component import Component
+from pyEDAA.IPXACT.Design    import Design
+from pyEDAA.IPXACT.DesignConfiguration import DesignConfiguration
 
 
 vlnv = Vlnv("VLSI-EDA", "PoC", "PoC", "1.0")

doc/Installation.rst

@@ -9,13 +9,13 @@ Installation using PIP
 
 .. code-block:: bash
 
-   pip3 install pyIPXACT
+   pip3 install pyEDAA.IPXACT
 
 
 Updating using PIP
 ==================
 
 .. code-block:: bash
 
-   pip3 install -U pyIPXACT
+   pip3 install -U pyEDAA.IPXACT
 

doc/Makefile

@@ -1,3 +1,6 @@
+CP=cp
+
+# Sphinx options.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
@@ -7,5 +10,19 @@ PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-%:
-	$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) $(BUILDDIR)/$@
+all: html latex
+
+#---
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+
+#---
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+#---
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

doc/conf.py

@@ -7,22 +7,26 @@
 from pathlib import Path
 from json import loads
 
+from pyTooling.Packaging import extractVersionInformation
+
 ROOT = Path(__file__).resolve().parent
 
 sys_path.insert(0, abspath('..'))
-#sys_path.insert(0, abspath('../pyIPXACT'))
+sys_path.insert(0, abspath('../pyEDAA/IPXACT'))
 #sys_path.insert(0, abspath('_extensions'))
 #sys_path.insert(0, abspath('_themes/sphinx_rtd_theme'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'pyIPXACT'
-copyright = '2007-2019, Patrick Lehmann'
-author = 'Patrick Lehmann'
+project = "pyEDAA.IPXACT"
+packageInformationFile = ROOT.parent / f"{project.replace('.', '/')}/__init__.py"
+versionInformation = extractVersionInformation(packageInformationFile)
 
-# The full version, including alpha/beta/rc tags
-release = 'v0.1'
+author =    versionInformation.Author
+copyright = versionInformation.Copyright
+version =   ".".join(versionInformation.Version.split(".")[:2])  # e.g. 2.3    The short X.Y version.
+release =   versionInformation.Version
 
 
 # -- General configuration ---------------------------------------------------

doc/index.rst

@@ -29,10 +29,10 @@
 
 .. Disabled shields: |SHIELD:png:IPXACT-codacy-quality| |SHIELD:png:IPXACT-codacy-coverage| |SHIELD:png:IPXACT-codecov-coverage| |SHIELD:png:IPXACT-lib-dep| |SHIELD:png:IPXACT-req-status| |SHIELD:png:IPXACT-lib-rank|
 
-pyIPXACT Documentation
-######################
+pyEDAA.IPXACT Documentation
+###########################
 
-pyIPXACT - An IP-XACT DOM (Document Object Model) for `IEEE 1685-2014 <https://standards.ieee.org/findstds/standard/1685-2014.html>`_
+pyEDAA.IPXACT - An IP-XACT DOM (Document Object Model) for `IEEE 1685-2014 <https://standards.ieee.org/findstds/standard/1685-2014.html>`_
 in Python.
 
 
@@ -95,12 +95,12 @@ This Python library (source code) is licensed under `Apache License 2.0 <License
    :caption: Classes
    :hidden:
 
-   pyIPXACT
-   pyIPXACT.Catalog
-   pyIPXACT.Component
-   pyIPXACT.Design
-   pyIPXACT.DesignConfiguration
-   pyIPXACT.GeneratorChain
+   pyEDAA.IPXACT/index
+   pyEDAA.IPXACT/Catalog
+   pyEDAA.IPXACT/Component
+   pyEDAA.IPXACT/Design
+   pyEDAA.IPXACT/DesignConfiguration
+   pyEDAA.IPXACT/GeneratorChain
 
 .. toctree::
    :caption: Appendix

doc/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/pyIPXACT.Design.rst → doc/pyEDAA.IPXACT/Catalog.rst

@@ -1,8 +1,8 @@
-pyIPXACT.Design
-###############
+pyEDAA.IPXACT.Catalog
+#####################
 
 
-.. automodule:: pyIPXACT.Design
+.. automodule:: pyEDAA.IPXACT.Catalog
    :show-inheritance:
    :members:
    :private-members:

doc/pyIPXACT.GeneratorChain.rst → doc/pyEDAA.IPXACT/Component.rst

@@ -1,7 +1,7 @@
-pyIPXACT.GeneratorChain
+pyEDAA.IPXACT.Component
 #######################
 
-.. automodule:: pyIPXACT.GeneratorChain
+.. automodule:: pyEDAA.IPXACT.Component
    :show-inheritance:
    :members:
    :private-members:

doc/pyIPXACT.Catalog.rst → doc/pyEDAA.IPXACT/Design.rst

@@ -1,8 +1,8 @@
-pyIPXACT.Catalog
-################
+pyEDAA.IPXACT.Design
+####################
 
 
-.. automodule:: pyIPXACT.Catalog
+.. automodule:: pyEDAA.IPXACT.Design
    :show-inheritance:
    :members:
    :private-members:

doc/pyEDAA.IPXACT/DesignConfiguration.rst

@@ -0,0 +1,8 @@
+pyEDAA.IPXACT.DesignConfiguration
+#################################
+
+.. automodule:: pyEDAA.IPXACT.DesignConfiguration
+   :show-inheritance:
+   :members:
+   :private-members:
+   :special-members: __init__

doc/pyIPXACT.DesignConfiguration.rst → doc/pyEDAA.IPXACT/GeneratorChain.rst

@@ -1,7 +1,7 @@
-pyIPXACT.DesignConfiguration
+pyEDAA.IPXACT.GeneratorChain
 ############################
 
-.. automodule:: pyIPXACT.DesignConfiguration
+.. automodule:: pyEDAA.IPXACT.GeneratorChain
    :show-inheritance:
    :members:
    :private-members:

doc/pyIPXACT.rst → doc/pyEDAA.IPXACT/index.rst

@@ -1,8 +1,8 @@
-pyIPXACT
-########
+pyEDAA.IPXACT
+#############
 
 
-.. automodule:: pyIPXACT
+.. automodule:: pyEDAA.IPXACT
    :show-inheritance:
    :members:
    :private-members:

doc/requirements.txt

@@ -1 +1,3 @@
 -r ../requirements.txt
+
+sphinx>=4.3.0

pyIPXACT/Catalog.py → pyEDAA/IPXACT/Catalog.py

@@ -42,8 +42,8 @@
 
 from pathlib            import Path
 
-from pyIPXACT           import RootElement, Vlnv, PyIpxactException, __URI_MAP__, __DEFAULT_SCHEMA__
-from pyIPXACT.Component import Component
+from pyEDAA.IPXACT           import RootElement, Vlnv, PyIpxactException, __URI_MAP__, __DEFAULT_SCHEMA__
+from pyEDAA.IPXACT.Component import Component
 
 
 class IpxactFile:

pyIPXACT/Component.py → pyEDAA/IPXACT/Component.py

@@ -36,7 +36,7 @@
 #
 from textwrap           import dedent
 
-from pyIPXACT           import RootElement, __DEFAULT_SCHEMA__
+from pyEDAA.IPXACT      import RootElement, __DEFAULT_SCHEMA__
 
 
 class Component(RootElement):

pyIPXACT/Design.py → pyEDAA/IPXACT/Design.py

@@ -36,7 +36,7 @@
 #
 from textwrap           import dedent
 
-from pyIPXACT import RootElement, __DEFAULT_SCHEMA__, Vlnv
+from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, Vlnv
 
 
 class Design(RootElement):

pyIPXACT/DesignConfiguration.py → pyEDAA/IPXACT/DesignConfiguration.py

@@ -36,7 +36,7 @@
 #
 from textwrap           import dedent
 
-from pyIPXACT import RootElement, __DEFAULT_SCHEMA__, Vlnv
+from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, Vlnv
 
 
 class DesignConfiguration(RootElement):

pyIPXACT/GeneratorChain.py → pyEDAA/IPXACT/GeneratorChain.py

@@ -36,7 +36,7 @@
 #
 from textwrap           import dedent
 
-from pyIPXACT import RootElement, __DEFAULT_SCHEMA__, Vlnv
+from pyEDAA.IPXACT import RootElement, __DEFAULT_SCHEMA__, Vlnv
 
 
 class GeneratorChain(RootElement):

pyIPXACT/__init__.py → pyEDAA/IPXACT/__init__.py

@@ -39,6 +39,13 @@
 from pathlib import Path
 
 
+__author__ =    "Patrick Lehmann"
+__email__ =     "Paebbels@gmail.com"
+__copyright__ = "2007-2021, Patrick Lehmann"
+__license__ =   "Apache License, Version 2.0"
+__version__ =   "0.2.1"
+
+
 class IpxactSchemaStruct:
 	"""Schema descriptor made of version, namespace prefix, URI, URL and local path."""
 

pyproject.toml

@@ -0,0 +1,10 @@
+[build-system]
+requires = [
+    "pyTooling >= 1.7.0",
+    "setuptools >= 35.0.2",
+    "wheel >= 0.29.0"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 120

requirements.txt

@@ -1 +1,2 @@
 lxml
+pyTooling>=1.7.0

setup.py

@@ -19,7 +19,7 @@
 #
 # License:
 # ============================================================================
-# Copyright 2017-2019 Patrick Lehmann - Bötzingen, Germany
+# Copyright 2017-2021 Patrick Lehmann - Bötzingen, Germany
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -34,33 +34,21 @@
 # limitations under the License.
 # ============================================================================
 #
-import setuptools
+from pathlib             import Path
+from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub
 
-with open("README.md", "r") as file:
-	long_description = file.read()
+gitHubNamespace =        "edaa-org"
+packageName =            "pyEDAA.IPXACT"
+packageDirectory =       packageName.replace(".", "/")
+packageInformationFile = Path(f"{packageDirectory}/__init__.py")
 
-setuptools.setup(
-	name="pyIPXACT",
-	version="0.1.6",
-	author="Patrick Lehmann",
-	author_email="Paebbels@gmail.com",
+DescribePythonPackageHostedOnGitHub(
+	packageName=packageName,
 	description="A Document-Object-Model (DOM) for IP-XACT files.",
-	long_description=long_description,
-	long_description_content_type="text/markdown",
-	url="https://github.com/Paebbels/pyIPXACT",
-	packages=setuptools.find_packages(),
+	gitHubNamespace=gitHubNamespace,
+	sourceFileWithVersion=packageInformationFile,
+	developmentStatus="pre-alpha",
 	classifiers=[
-		"License :: OSI Approved :: Apache Software License",
-		"Operating System :: OS Independent",
-		"Programming Language :: Python :: 3.5",
-		"Programming Language :: Python :: 3.6",
-		"Programming Language :: Python :: 3.7",
-		"Programming Language :: Python :: 3.8",
-		"Development Status :: 2 - Pre-Alpha",
-		#   "Development Status :: 3 - Alpha",
-		#		"Development Status :: 4 - Beta",
-		#		"Development Status :: 5 - Production/Stable",
-		"Topic :: Utilities"
-	],
-	python_requires='>=3.5',
+		"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+	]
 )