Prepare first release (#68)

- ReadTheDocs updated
- status badges on main page (README) are reorganized
- tidelift funding configured
- package published on PyPI

.github/FUNDING.yml

@@ -2,6 +2,6 @@ github: [mdabrowski1990]
 issuehunt: mdabrowski1990
 liberapay: mdabrowski1990
 otechie: mdabrowski
-#TODO: tidelift - once released on PyPI
+tidelift: pypi/py-uds
 community_bridge: uds
-custom: ['https://paypal.me/pools/c/8xzKVUT0ba', 'https://paypal.me/pools/c/8xBlQ11Adr', 'https://paypal.me/pools/c/8xBlUHGPpE', 'https://paypal.me/pools/c/8xBm451jNW']
+custom: []

README.rst

@@ -3,31 +3,38 @@ UDS
 *****
 
 .. image:: https://github.com/mdabrowski1990/uds/actions/workflows/ci.yml/badge.svg?branch=main
-   :target: https://github.com/mdabrowski1990/uds/actions
+   :target: https://github.com/mdabrowski1990/uds/actions/workflows/ci.yml
    :alt: Continuous Integration
 
+.. image:: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml/badge.svg?branch=main
+   :target: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml
+   :alt: Security Scan Status
+
 .. image:: https://travis-ci.com/mdabrowski1990/uds.svg?branch=main
    :target: https://travis-ci.com/mdabrowski1990/uds
    :alt: Build Status
 
-.. image:: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml/badge.svg?branch=main
-   :target: https://github.com/mdabrowski1990/uds/actions/workflows/codeql-analysis.yml
-
-.. image:: https://coveralls.io/repos/github/mdabrowski1990/uds/badge.svg?branch=main
-   :target: https://coveralls.io/github/mdabrowski1990/uds?branch=main
-
 .. image:: https://readthedocs.org/projects/uds/badge/?version=latest
    :target: https://uds.readthedocs.io/
    :alt: Documentation
-
+
+.. image:: https://coveralls.io/repos/github/mdabrowski1990/uds/badge.svg?branch=main
+   :target: https://coveralls.io/github/mdabrowski1990/uds?branch=main
+   :alt: Coverage
+
+.. image:: https://img.shields.io/pypi/v/py-uds.svg
+   :target: https://pypi.python.org/pypi/py-uds
+   :alt: Latest Version of UDS
+
 .. image:: https://bestpractices.coreinfrastructure.org/projects/4703/badge
    :target: https://bestpractices.coreinfrastructure.org/projects/4703
-
+   :alt: CII Best Practices
+
 .. image:: https://img.shields.io/badge/License-MIT-blue.svg
    :target: https://lbesson.mit-license.org/
+   :alt: License
 
-
-Python package for handling `Unified Diagnostic Services`__ (UDS_) protocol defined by ISO 14229.
+Python package for handling `Unified Diagnostic Services`_ (UDS_) protocol defined by ISO 14229.
 It supports different communication buses on both communication sides (client and server).
 
 
@@ -48,5 +55,5 @@ Contact
 
 
 
+.. _Unified Diagnostic Services: https://en.wikipedia.org/wiki/Unified_Diagnostic_Services
 .. _UDS: https://en.wikipedia.org/wiki/Unified_Diagnostic_Services
-__ UDS_

docs/source/pages/installation.rst

@@ -1,4 +1,16 @@
 Installation
 ============
-This chapter will be updates after the package is published on PyPI.
-At the moment, the only option to get the code is to download it from https://github.com/mdabrowski1990/uds.
+
+.. role:: shell(code)
+    :language: shell
+
+To install the package, run the following command in your command line interface:
+
+:shell:`pip install py-uds`
+
+If you have already installed the package, you can update it using the following command:
+
+:shell:`pip install -U py-uds`
+
+UDS package is distributed via `PyPI <https://pypi.org/>`_.
+You can visit distribution page of UDS package using the following hyperlink: https://pypi.org/project/py-uds/.

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,47 @@
+[metadata]
+name = py-uds
+url = https://github.com/mdabrowski1990/uds
+project_urls =
+    Wiki = https://github.com/mdabrowski1990/uds/wiki
+    Security policy = https://github.com/mdabrowski1990/uds/security/policy
+    Issues Tracking System = https://github.com/mdabrowski1990/uds/issues
+    User Documentation = https://uds.readthedocs.io/en/latest/
+description = UDS (Unified Diagnostic Services) protocol handler. It supports CAN, Ethernet, LIN, FlexRay, K-Line with possible extension for any other bus.
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+license = MIT
+license_file = LICENSE
+classifiers =
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Natural Language :: English
+    Development Status :: 4 - Beta
+    Intended Audience :: Developers
+    Topic :: Scientific/Engineering
+    Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+    Topic :: Software Development :: Embedded Systems
+    Topic :: System :: Logging
+    Topic :: System :: Monitoring
+    Topic :: System :: Networking
+    Topic :: Utilities
+package_dir =
+    =uds
+python_requires = >=3.6
+
+
+[options]
+zip_safe = False
+include_package_data = True
+
+
+[options.package_data]
+* = *.md, *.rst, *.txt
+docs = source/*.rst, source/pages/*.rst, source/*.png, source/*.drawio

setup.py

@@ -0,0 +1,21 @@
+import setuptools
+import re
+
+install_requires = [
+    "aenum"
+]
+
+with open("uds/__init__.py", "r", encoding="utf-8") as init_file:
+    version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', init_file.read(), re.MULTILINE).group(1)
+    init_file.seek(0)
+    author = re.search(r'^__author__\s*=\s*[\'"]([^\'"]*)[\'"]', init_file.read(), re.MULTILINE).group(1)
+    init_file.seek(0)
+    email = re.search(r'^__email__\s*=\s*[\'"]([^\'"]*)[\'"]', init_file.read(), re.MULTILINE).group(1)
+
+packages = setuptools.find_packages(exclude=["tests", "tests.*", "docs"])
+
+setuptools.setup(version=version,
+                 author=author,
+                 author_email=email,
+                 packages=packages,
+                 install_requires=install_requires)

uds/__init__.py

@@ -13,7 +13,6 @@
 """
 
 __all__ = ["messages"]
-__version__ = "0.0.0"
+__version__ = "0.0.2"
 __author__ = "Maciej Dąbrowski"
-# __credits__ = []  TODO: place for sponsors and other stakeholders
 __email__ = "uds-package-development@googlegroups.com"