minor updates

Author: jposada202020

.gitignore

@@ -1,48 +1,15 @@
-# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries
+# SPDX-FileCopyrightText: 2023 Jose D. Montoya
 #
 # SPDX-License-Identifier: MIT
 
-# Do not include files and directories created by your personal work environment, such as the IDE
-# you use, except for those already listed here. Pull requests including changes to this file will
-# not be accepted.
-
-# This .gitignore file contains rules for files generated by working with MicroPython libraries,
-# including building Sphinx, testing with pip, and creating a virual environment, as well as the
-# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs.
-
-# If you find that there are files being generated on your machine that should not be included in
-# your git commit, you should create a .gitignore_global file on your computer to include the
-# files created by your personal setup. To do so, follow the two steps below.
-
-# First, create a file called .gitignore_global somewhere convenient for you, and add rules for
-# the files you want to exclude from git commits.
-
-# Second, configure Git to use the exclude file for all Git repositories by running the
-# following via commandline, replacing "path/to/your/" with the actual path to your newly created
-# .gitignore_global file:
-# git config --global core.excludesfile path/to/your/.gitignore_global
-
-# MicroPython-specific files
 *.mpy
-
-# Python-specific files
 __pycache__
 *.pyc
-
-# Sphinx build-specific files
 _build
-
-# This file results from running `pip -e install .` in a local repository
 *.egg-info
-
-# Virtual environment-specific files
 .env
 .venv
-
-# MacOS-specific files
 *.DS_Store
-
-# IDE-specific files
 .idea
 .vscode
 *~

.pre-commit-config.yaml

@@ -21,18 +21,11 @@ repos:
  types: [python]
  args:
  - --disable=consider-using-f-string
- exclude: "^(docs/|examples/|tests/|setup.py$)"
+ exclude: "^(docs/|examples/|tests/)"
  - id: pylint
  name: pylint (example code)
  description: Run pylint rules on "examples/*.py" files
  types: [python]
  files: "^examples/"
  args:
  - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
- - id: pylint
- name: pylint (test code)
- description: Run pylint rules on "tests/*.py" files
- types: [python]
- files: "^tests/"
- args:
- - --disable=missing-docstring,consider-using-f-string,duplicate-code

.readthedocs.yaml

@@ -5,7 +5,7 @@
 version: 2
 
 build:
- os: ubuntu-20.04
+ os: ubuntu-22.04
  tools:
  python: "3"
 

docs/conf.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2023 Jose D. Montoya
 #
 # SPDX-License-Identifier: MIT
@@ -32,7 +30,6 @@
 extensions = [
  "sphinx.ext.autodoc",
  "sphinx.ext.intersphinx",
- "sphinx.ext.napoleon",
  "sphinx.ext.viewcode",
  "sphinx_immaterial",
 ]
@@ -203,61 +200,3 @@
 # These paths are either relative to html_static_path
 # or fully qualified paths (eg. https://...)
 html_css_files = ["extra_css.css"]
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- # 'papersize': 'letterpaper',
- # The font size ('10pt', '11pt' or '12pt').
- # 'pointsize': '10pt',
- # Additional stuff for the LaTeX preamble.
- # 'preamble': '',
- # Latex figure (float) alignment
- # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (
- master_doc,
- "MicroPython_shtc3_Library.tex",
- "MicroPython shtc3 Library Documentation",
- author,
- "manual",
- ),
-]
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (
- master_doc,
- "MicroPython_shtc3_Library",
- "MicroPython shtc3 Library Documentation",
- [author],
- 1,
- ),
-]
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (
- master_doc,
- "MicroPython_shtc3_Library",
- "MicroPython shtc3 Library Documentation",
- author,
- "MicroPython_shtc3_Library",
- "One line description of project.",
- "Miscellaneous",
- ),
-]

docs/index.rst

@@ -24,4 +24,4 @@ Table of Contents
 .. toctree::
  :caption: Other Links
 
- Download from GitHub <https://github.com/jposada202020/MciroPython_SHTC3/releases/latest>
+ Download from GitHub <https://github.com/jposada202020/MicroPython_SHTC3/releases/latest>

examples.json

@@ -1,7 +1,13 @@
 {
  "urls": [
- ["micropython_shtc3/examples/shtc3_power_mode.py", "github:jposada202020/MicroPython_SHTC3/examples/shtc3_power_mode.py"],
- ["micropython_shtc3/examples/shtc3_simpletest.py", "github:jposada202020/MicroPython_SHTC3/examples/shtc3_simpletest.py"]
+ [
+ "micropython_shtc3/examples/shtc3_power_mode.py",
+ "github:jposada202020/MicroPython_SHTC3/examples/shtc3_power_mode.py"
+ ],
+ [
+ "micropython_shtc3/examples/shtc3_simpletest.py",
+ "github:jposada202020/MicroPython_SHTC3/examples/shtc3_simpletest.py"
+ ]
  ],
- "version": "0.1"
-}
+ "version": "1"
+}

examples/shtc3_power_mode.py

@@ -20,7 +20,7 @@
  print("Current Operation mode setting: ", sht.power_mode)
  for _ in range(10):
  temp = sht.temperature
- print("Temperature: {:.2f}C".format(temp))
+ print(f"Temperature: {temp:0.1f}°C")
  print()
  time.sleep(0.5)
  sht.power_mode = power_mode

examples/shtc3_simpletest.py

@@ -11,7 +11,7 @@
 
 while True:
  temperature, relative_humidity = sht.measurements
- print("Temperature: {:0.1f} C".format(temperature))
- print("Humidity: {:0.1f} %%".format(relative_humidity))
+ print(f"Temperature: {temperature:0.1f}°C")
+ print(f"Humidity: {relative_humidity:0.1f}%")
  print()
  time.sleep(0.5)

package.json

@@ -1,7 +1,13 @@
 {
  "urls": [
- ["micropython_shtc3/__init__.py", "github:jposada202020/MicroPython_SHTC3/micropython_shtc3/__init__.py"],
- ["micropython_shtc3/shtc3.py", "github:jposada202020/MicroPython_SHTC3/micropython_shtc3/shtc3.py"]
+ [
+ "micropython_shtc3/__init__.py",
+ "github:jposada202020/MicroPython_SHTC3/micropython_shtc3/__init__.py"
+ ],
+ [
+ "micropython_shtc3/shtc3.py",
+ "github:jposada202020/MicroPython_SHTC3/micropython_shtc3/shtc3.py"
+ ]
  ],
- "version": "0.1"
-}
+ "version": "1"
+}

pyproject.toml

@@ -21,8 +21,6 @@ urls = {Homepage = "https://github.com/jposada202020/MicroPython_SHTC3"}
 keywords = [
  "sensor",
  "micropython",
- "shtc3",
- "micropython",
  "driver",
  "sensor",
  "shtc3",