diff --git a/semantic-conventions/README.rst b/semantic-conventions/README.rst new file mode 100644 index 00000000..7efa10da --- /dev/null +++ b/semantic-conventions/README.rst @@ -0,0 +1,16 @@ +OpenTelemetry Semantic Convention Utility Tools +=============================================== + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-semconvgen.svg + :target: https://pypi.org/project/opentelemetry-semconvgen/ + +This library is provided as a convenience to access the OpenTelemetry Semantic Convention Generator, and semantic convention syntax parsing. + +Installation +------------ + +:: + + pip install opentelemetry-semconvgen \ No newline at end of file diff --git a/semantic-conventions/setup.cfg b/semantic-conventions/setup.cfg index ce15e71c..3cfa3d8d 100644 --- a/semantic-conventions/setup.cfg +++ b/semantic-conventions/setup.cfg @@ -13,15 +13,15 @@ # limitations under the License. # [metadata] -name = semconvgen -description = OpenTelemetry Semantic Conventions utility +name = opentelemetry-semconvgen +description = OpenTelemetry Semantic Conventions Utilities author = The OpenTelemetry Authors author_email = cncf-opentelemetry-contributors@lists.cncf.io -url = https://github.com/dynatrace-oss-contrib/build-tools/ +url = https://github.com/open-telemetry/build-tools platforms = any license = Apache-2.0 classifiers = - Development Status :: 1 - Alpha + Development Status :: 3 - Alpha Intended Audience :: Developers License :: OSI Approved :: Apache Software License Programming Language :: Python @@ -36,10 +36,10 @@ package_dir= =src packages=find_namespace: install_requires = - dataclasses~=0.6 + dataclasses~=0.6;python_version<'3.7' ruamel.yaml~=0.16 Jinja2~=3.0 - mistune==2.0.0a6 + mistune==2.0.0 [options.packages.find] where = src diff --git a/semantic-conventions/setup.py b/semantic-conventions/setup.py index b560307d..f05d0613 100644 --- a/semantic-conventions/setup.py +++ b/semantic-conventions/setup.py @@ -14,8 +14,16 @@ VERSION_SUFFIX = os.environ.get("SEMCONGEN_VERSION_SUFFIX") PUBLIC_VERSION = PACKAGE_INFO["__version__"] +# long description +README_FILENAME = os.path.join(BASE_DIR, "README.rst") +LONG_DESCRIPTION = "" +with open(README_FILENAME, encoding="utf-8") as f: + LONG_DESCRIPTION = f.read() + setuptools.setup( version=PUBLIC_VERSION if not VERSION_SUFFIX - else PUBLIC_VERSION + "+" + VERSION_SUFFIX + else PUBLIC_VERSION + "+" + VERSION_SUFFIX, + long_description=LONG_DESCRIPTION, + long_description_content_type="text/x-rst", )