ipycalc 0.0.73__tar.gz

ipycalc-0.0.73/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 D. Craig Brinck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ipycalc-0.0.73/MANIFEST.in

@@ -0,0 +1 @@
+graft ipycalc

ipycalc-0.0.73/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: ipycalc
+Version: 0.0.73
+Summary: Clean looking engineering calculations for IPython
+Home-page: https://github.com/JWock82/ipycalc.git
+Author: D. Craig Brinck, PE, SE
+Author-email: Building.Code@outlook.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jupyterlab
+Requires-Dist: nbconvert>=6.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# ipycalc
+Simple Engineering Calculations in Python
+
+Turn the contents of a Jupyter cell into a formatted calculation by following the steps below:
+
+1. Install `ipycalc` using `pip install ipycalc`
+2. Use `from ipycalc import calc` to bring `ipycalc` into your notebook's namespace.
+3. Use `%%calc` as the first line of a cell to indicate that you want to run `ipycalc` on the contents of a cell.
+
+The basic calculation syntax is:
+
+Variable Description: `variable_name` = `python_expression` -> `result_decimal_places`*`result_unit` # Reference Text
+
+Here's a simple example that calculates the flexural strength of a concrete beam:
+
+![Example](/Example.png)
+
+Key components of the `ipycalc` syntax are:
+
+* `:` (required) The description must come before this character.
+* `=` (optional) Used to assign a python expression to a variable name. Omit this if you simply want to reprint a previously defined variable.
+* `->` (optional) Separates the python expression from the results formatting rules.
+* `*` (optional) Indicate the number of decimals you want to see in the result to the left of the `*`, and the units you want to see in the result to the right.
+* `#` (optional) Indicates reference text to the side of the calculation - handy for equation references or code references.
+
+Here are a few useful things to keep in mind when using `ipycalc`:
+
+* Subscripts can be added by using the `_` character to indicate the start of a subscript.
+* Greek characters included in the `python_expression` can just be written out (e.g. `epsilon`). To include greek characters in the Variable Description or the Reference Text, you can use Jupyter's Markdown Latex tags (e.g. `$\epsilon$`).
+* To stack fractions place the numerator and denominater in parentheses: (num)/(denom) yields $\dfrac{num}{denom}$.
+* `if` statements and `else` statements are available using python's inline `if` statement (terniary) notation.
+* Square roots can be displayed using `sqrt`.
+* Prime characters can be displayed using `^prime`.
+* If text gets to lengthy to fit on one line, you can add `\\` to force a line break anywhere in a line. This can help your calculations fit within the page's print margins.
+* `ipycalc` assists you with printing your notebooks. It has a built in `nbconvert` template called `ipycalc` that works just like the `webpdf` template, except it fixes the the bad margins in the `webpdf` template, and avoids page breaks right after headers. Any cells tagged with `hide_cell` will not be rendered. Any cells tagged with `hide_input` will only show the output upon printing. You can select it from the file menu via "File -> Save and Export Notebook As... -> Ipycalc"
+
+IPycalc is still in development. There could be bugs, so be cautious and validate the answers it gives you. A special thanks to @connorferster for his project `handcalcs` which inspired this project. A link to `handcalcs` is here: https://github.com/connorferster/handcalcs.

ipycalc-0.0.73/README.md

@@ -0,0 +1,37 @@
+# ipycalc
+Simple Engineering Calculations in Python
+
+Turn the contents of a Jupyter cell into a formatted calculation by following the steps below:
+
+1. Install `ipycalc` using `pip install ipycalc`
+2. Use `from ipycalc import calc` to bring `ipycalc` into your notebook's namespace.
+3. Use `%%calc` as the first line of a cell to indicate that you want to run `ipycalc` on the contents of a cell.
+
+The basic calculation syntax is:
+
+Variable Description: `variable_name` = `python_expression` -> `result_decimal_places`*`result_unit` # Reference Text
+
+Here's a simple example that calculates the flexural strength of a concrete beam:
+
+![Example](/Example.png)
+
+Key components of the `ipycalc` syntax are:
+
+* `:` (required) The description must come before this character.
+* `=` (optional) Used to assign a python expression to a variable name. Omit this if you simply want to reprint a previously defined variable.
+* `->` (optional) Separates the python expression from the results formatting rules.
+* `*` (optional) Indicate the number of decimals you want to see in the result to the left of the `*`, and the units you want to see in the result to the right.
+* `#` (optional) Indicates reference text to the side of the calculation - handy for equation references or code references.
+
+Here are a few useful things to keep in mind when using `ipycalc`:
+
+* Subscripts can be added by using the `_` character to indicate the start of a subscript.
+* Greek characters included in the `python_expression` can just be written out (e.g. `epsilon`). To include greek characters in the Variable Description or the Reference Text, you can use Jupyter's Markdown Latex tags (e.g. `$\epsilon$`).
+* To stack fractions place the numerator and denominater in parentheses: (num)/(denom) yields $\dfrac{num}{denom}$.
+* `if` statements and `else` statements are available using python's inline `if` statement (terniary) notation.
+* Square roots can be displayed using `sqrt`.
+* Prime characters can be displayed using `^prime`.
+* If text gets to lengthy to fit on one line, you can add `\\` to force a line break anywhere in a line. This can help your calculations fit within the page's print margins.
+* `ipycalc` assists you with printing your notebooks. It has a built in `nbconvert` template called `ipycalc` that works just like the `webpdf` template, except it fixes the the bad margins in the `webpdf` template, and avoids page breaks right after headers. Any cells tagged with `hide_cell` will not be rendered. Any cells tagged with `hide_input` will only show the output upon printing. You can select it from the file menu via "File -> Save and Export Notebook As... -> Ipycalc"
+
+IPycalc is still in development. There could be bugs, so be cautious and validate the answers it gives you. A special thanks to @connorferster for his project `handcalcs` which inspired this project. A link to `handcalcs` is here: https://github.com/connorferster/handcalcs.

ipycalc-0.0.73/ipycalc/__init__.py

@@ -0,0 +1,38 @@
+import os
+from nbconvert.exporters import WebPDFExporter
+from nbconvert.preprocessors import TagRemovePreprocessor
+
+class ipycalcExporter(WebPDFExporter):
+    """
+    A custom PDF exporter for ipycalc.
+    """
+
+    # This is the name of the folder containing the template in `ipycalc`
+    custom_template_name = 'nbconvert_template'
+
+    # This is the directory where ipycalc is installed on the user's machine
+    pkg_dir = os.path.dirname(__file__)
+
+    # This is the location where the `ipycalc` template is installed on the user's machine
+    template_dir = os.path.join(pkg_dir, custom_template_name)
+
+    def __init__(self, config=None, **kw):
+
+        super().__init__(config=config, **kw)
+
+        # Set up preprocessors
+        trp = TagRemovePreprocessor()
+        trp.remove_cell_tags=['hide_cell']
+        trp.remove_input_tags=['hide_input']
+        self.register_preprocessor(trp, enabled=True)
+        self.embed_images=True
+        self.exclude_input_prompt=True
+        self.exclude_output_prompt=True
+
+    @property
+    def _extra_template_basedirs(self):
+        return super()._default_extra_template_basedirs() + [self.template_dir]
+    
+    def _template_name_default(self):
+        return os.path.join(self.pkg_dir, self.custom_template_name)
+