From 21e929e773858a7aecf289fc350dcc01598ded55 Mon Sep 17 00:00:00 2001 From: JuanBindez Date: Fri, 14 Jun 2024 23:51:38 -0300 Subject: [PATCH] ohmslaw 1.0.0 Released --- README.md | 54 ++++++++++++++++++++++++------------- build.rocketfile | 4 +-- docs/user/current.rst | 6 ++--- docs/user/find_resistor.rst | 8 +++--- docs/user/quickstart.rst | 4 +-- docs/user/resistance.rst | 4 +-- docs/user/volts.rst | 6 +---- docs/user/watts.rst | 7 +++-- main.py | 6 ----- ohmslaw/version.py | 2 +- pyproject.toml | 2 +- 11 files changed, 53 insertions(+), 50 deletions(-) delete mode 100644 main.py diff --git a/README.md b/README.md index ca3e3e5..e245b84 100644 --- a/README.md +++ b/README.md @@ -24,33 +24,47 @@ from ohmslaw import Ohms ### current multiplied by resistance = voltage ```python - -o = Ohms() -results = o.volts(2, 4) - -print(results) +>>> o = Ohms() +>>> results = o.volts(I=12, R=4) +>>> +>>> print(results) +48 +>>> ``` ### voltage Divided by resistance = current ```python - -o = Ohms() -results = o.current(12, 4) - -print(results) - +>>> o = Ohms() +>>> results = o.current(V=12, R=4) +>>> +>>> print(results) +3.0 +>>> ``` ### voltage divided by current = resistance ```python +>>> o = Ohms() +>>> results = o.resistance(V=48, I=4) +>>> +>>> print(results) +12.0 +>>> -o = Ohms() -results = o.resistance(48, 4) +``` + +### Watts -print(results) +```python +>>> o = Ohms() +>>> results = o.watts(I=2, R=15) +>>> +>>> print(results) +60 +>>> ``` @@ -58,9 +72,13 @@ print(results) ```python -o = Ohms() -results = o.find_resistor(source=48, component_voltage=12)# Led - -print(results) +>>> o = Ohms() +>>> results = o.find_resistor(source=48, +... component_voltage=12, +... component_current=1) +>>> +>>> print(results) +36.0 +>>> ``` diff --git a/build.rocketfile b/build.rocketfile index 827bd6b..872354c 100644 --- a/build.rocketfile +++ b/build.rocketfile @@ -1,7 +1,7 @@ git add . -git commit -m 'update' +git commit -m 'ohmslaw 1.0.0 Released' git push -u origin main -git tag v1.0-rc13 +git tag v1.0.0 git push --tag make clean make upload \ No newline at end of file diff --git a/docs/user/current.rst b/docs/user/current.rst index 0d719dc..77894a7 100644 --- a/docs/user/current.rst +++ b/docs/user/current.rst @@ -5,11 +5,9 @@ Current: **returns the electrical current:**:: - >>> from ohmslaw import Ohms - >>> >>> o = Ohms() - >>> results = o.current(12, 4) + >>> results = o.current(V=12, R=4) >>> >>> print(results) 3.0 - + >>> diff --git a/docs/user/find_resistor.rst b/docs/user/find_resistor.rst index 87cc110..a649182 100644 --- a/docs/user/find_resistor.rst +++ b/docs/user/find_resistor.rst @@ -5,11 +5,11 @@ Find Resistor: **find the resistance value to limit the electrical voltage of a circuit:**:: - >>> from ohmslaw import Ohms - >>> >>> o = Ohms() - >>> results = o.find_resistor(source=48, component_voltage=12)# Led + >>> results = o.find_resistor(source=48, + ... component_voltage=12, + ... component_current=1) >>> >>> print(results) - 1800.0 + 36.0 >>> diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index a8fdc41..e59c443 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -13,7 +13,7 @@ Quickstart: >>> from ohmslaw import Ohms >>> >>> o = Ohms() - >>> results = o.resistance(48, 4) + >>> results = o.resistance(V=48, I=4) >>> >>> print(results) 12.0 @@ -24,7 +24,7 @@ Quickstart: >>> from ohmslaw import Ohms >>> >>> o = Ohms() - >>> results = o.current(12, 4) + >>> results = o.current(V=12, R=4) >>> >>> print(results) 3.0 diff --git a/docs/user/resistance.rst b/docs/user/resistance.rst index 67cb5bc..880cade 100644 --- a/docs/user/resistance.rst +++ b/docs/user/resistance.rst @@ -5,10 +5,8 @@ Resistance: **calculate resistance in ohms:**:: - >>> from ohmslaw import Ohms - >>> >>> o = Ohms() - >>> results = o.resistance(48, 4) + >>> results = o.resistance(V=48, I=4) >>> >>> print(results) 12.0 diff --git a/docs/user/volts.rst b/docs/user/volts.rst index 47a6e58..0966a18 100644 --- a/docs/user/volts.rst +++ b/docs/user/volts.rst @@ -5,14 +5,10 @@ volts: **calculate volts using ohms law:**:: - >>> from ohmslaw import Ohms - >>> >>> o = Ohms() - >>> results = o.volts(12, 4) - >>> + >>> results = o.volts(I=12, R=4) >>> >>> print(results) 48 >>> - diff --git a/docs/user/watts.rst b/docs/user/watts.rst index f57cd24..2867251 100644 --- a/docs/user/watts.rst +++ b/docs/user/watts.rst @@ -5,10 +5,9 @@ watts **calculate power in watts:**:: - >>> from ohmslaw import Ohms - >>> >>> o = Ohms() - >>> results = o.watts(2, 15) + >>> results = o.watts(I=2, R=15) + >>> >>> print(results) 60 - + >>> \ No newline at end of file diff --git a/main.py b/main.py deleted file mode 100644 index b29e4be..0000000 --- a/main.py +++ /dev/null @@ -1,6 +0,0 @@ -from ohmslaw import Ohms - -o = Ohms() -results = o.watts(2, 15) - -print(results) \ No newline at end of file diff --git a/ohmslaw/version.py b/ohmslaw/version.py index 7fc3dd9..0afd4be 100644 --- a/ohmslaw/version.py +++ b/ohmslaw/version.py @@ -1,4 +1,4 @@ -__version__ = "1.0-rc13" +__version__ = "1.0.0" if __name__ == "__main__": print(__version__) diff --git a/pyproject.toml b/pyproject.toml index ded0ebd..b673ad0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "ohmslaw" -version = "1.0-rc13" +version = "1.0.0" authors = [ { name="Juan Bindez", email="juanbindez780@gmail.com" }, ]