bump: version 0.0.2 → 0.0.3

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.3 (2023-10-02)
+
+### Fix
+
+-  Corrected setup entry point
+
 ## 0.0.2 (2023-10-02)
 
 ### Fix

pyFoamd.egg-info/PKG-INFO

@@ -1,10 +1,7 @@
 Metadata-Version: 2.1
-Name: pyFoamd
-Version: 0.1.0
-Summary: Pythonic interface for OpenFOAM dictionaries and case files.
-Home-page: https://github.com/mcgoldba/pyFoamd
-Author: Marc Goldbach
-Author-email: [email protected]
+Name: pyfoamd
+Version: 0.0.2
+Author-email: Marc Goldbach <[email protected]>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
 
@@ -680,9 +677,80 @@ License:                     GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 
+Project-URL: Home, https://github.com/mcgoldba/pyFoamd
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pint
+Requires-Dist: pandas
+Requires-Dist: rich
+Requires-Dist: ipython
+
+pyFoamd
+-------
 
-# pyFoamd
 Pythonic modification of OpenFOAM dictionaries and case files.
+
+Installation
+------------
+
+.. code-block:: bash
+
+    python -m pip install pyfoamd
+
+Basic Usage
+-----------
+
+Copy a template case and load as a python object
+
+.. code-block:: bash
+
+    cp $FOAM_TUTORIALS/incompressible/simpleFoam/pitzDaily .
+    cd pitzDaily
+    pf init
+
+View case variables
+
+.. code-block:: bash
+
+    pf edit
+
+.. code-block:: python
+
+    >>> case.constant.turbulenceProperties.RAS.RASModel
+    kEpsilon
+
+Change case dictionary entries
+
+.. code-block:: python
+
+    >>> case.constant.case.constant.turbulenceProperties.RAS.RASModel = kOmega
+
+Write the updated case to file
+
+.. code-block:: python
+
+    >>> case.write()
+
+Run the Allrun script
+
+.. code-block:: python
+
+    >>> case.run()
+
+Releasing
+---------
+
+Releases are published automatically when a tag is pushed to GitHub.
+
+.. code-block:: bash
+
+   # Set next version number
+   export RELEASE=x.x.x
+
+   # Create tags
+   git commit --allow-empty -m "Release $RELEASE"
+   git tag -a $RELEASE -m "Version $RELEASE"
+
+   # Push
+   git push upstream --tags

pyFoamd.egg-info/SOURCES.txt

@@ -1,6 +1,6 @@
 LICENSE
 README.md
-setup.py
+pyproject.toml
 pyFoamd.egg-info/PKG-INFO
 pyFoamd.egg-info/SOURCES.txt
 pyFoamd.egg-info/dependency_links.txt
@@ -11,6 +11,12 @@ pyfoamd/__init__.py
 pyfoamd/__main__.py
 pyfoamd/functions.trash.py
 pyfoamd/richinclude.py
+pyfoamd.egg-info/PKG-INFO
+pyfoamd.egg-info/SOURCES.txt
+pyfoamd.egg-info/dependency_links.txt
+pyfoamd.egg-info/entry_points.txt
+pyfoamd.egg-info/requires.txt
+pyfoamd.egg-info/top_level.txt
 pyfoamd/commandline/__init__.py
 pyfoamd/commandline/_iPython_env.py
 pyfoamd/functions/__init__.py

pyproject.toml

@@ -10,16 +10,16 @@ dependencies = [
         'rich',
         'ipython'
         ]
-version = "0.0.2"
+version = "0.0.3"
 
 [project.urls]
 Home = "https://github.com/mcgoldba/pyFoamd"
 
 [project.scripts]
 pf = "pyfoamd.__main__:main"
 
-[tool.setuptools.packages.find]
-where = ["pyfoamd"]
+[tool.setuptools]
+packages = ["pyfoamd"]
 
 
 [tool.commitizen]