chore: rename python package as xsk_pytools (#27)

* chore: rename python package as `xsk_pytools` * chore: modify corresponding package calling * fix: modify package name in pyproject.toml
xshaokun · Mar 13, 2023 · 4e7a3d0 · 4e7a3d0
1 parent 08c3068
commit 4e7a3d0
Show file tree

Hide file tree

Showing 9 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -9,13 +9,13 @@
 
 ## pytools
 
-Note that `pytools` can be installed by `pip` so that it is added to your python's import path:
+Note that the modules under `pytools` are wrapped as a standard python package `xsk_pytools` (refer to `pytools/pyproject.toml`), which can be installed by `pip`:
 
     $ cd pytools && python -m pip install --user -e .
 
 Then, it can be imported in your python script:
 
-    import pytools
+    import xsk_pytools
 
 ## Contact Me
 If you have any questions, please feel free to ask me. My name is Shaokun Xie. The contact details are not listed here. Please go to find the right approach in somewhere and contact me : p
diff --git a/pytools/README.md b/pytools/README.md
@@ -8,10 +8,11 @@ Some python tools useful in other python code.
 * `pluto_tools.py`: some tools  used specificaly for PLUTO simulations
 * `tools.py`: some general used tools
 
-Note that `pytools` can be installed by `pip` under this directory so that it is added to your python's import path:
+Note that the modules here are wrapped as a standard python package `xsk_pytools` (refer to
+`pyproject.toml`), which can be installed by `pip`:
 
     $ python -m pip install --user -e .
 
 Then, it can be imported in your python script:
 
-    import pytools
+    import xsk_pytools
diff --git a/pytools/pyproject.toml b/pytools/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "pytools_xsk"
+name = "xsk_pytools"
 version = "0.1.1"
 description = "A Python toolbox for personal daily research"
 readme = "README.md"

diff --git a/pytools/src/__init__.py → pytools/xsk_pytools/__init__.py b/pytools/src/__init__.py → pytools/xsk_pytools/__init__.py
diff --git a/pytools/src/astroeqs.py → pytools/xsk_pytools/astroeqs.py b/pytools/src/astroeqs.py → pytools/xsk_pytools/astroeqs.py
diff --git a/pytools/src/fermi.py → pytools/xsk_pytools/fermi.py b/pytools/src/fermi.py → pytools/xsk_pytools/fermi.py
diff --git a/pytools/src/logger.py → pytools/xsk_pytools/logger.py b/pytools/src/logger.py → pytools/xsk_pytools/logger.py
diff --git a/pytools/src/pluto_tools.py → pytools/xsk_pytools/pluto_tools.py b/pytools/src/pluto_tools.py → pytools/xsk_pytools/pluto_tools.py
@@ -2,7 +2,7 @@
 
 import pandas as pd
 
-from pytools.tools import nearest, str_to_number
+from xsk_pytools.tools import nearest, str_to_number
 
 
 def output_index(logfile, ns):

diff --git a/pytools/src/tools.py → pytools/xsk_pytools/tools.py b/pytools/src/tools.py → pytools/xsk_pytools/tools.py