Pip Upgrade

README.md

@@ -57,6 +57,14 @@ mamba create --name domhmm
 mamba activate domhmm
 ```
 
+#### Installing with PyPI
+
+DomHMM can be installed directly with pip
+
+```
+pip install domhmm
+```
+
 #### Installing directly from the repository without cloning
 
 If you want to install the latest version of DomHMM directly from the repository (either from the `main` branch or any other branch), you can use the following command:

docs/source/installation.rst

@@ -2,18 +2,6 @@ Installation
 =============
 Installation can be done in two different ways
 
-.. note::
-    DomHMM is planning to be published also in PyPI. Which means in future, it can be directly install via pip and can be usable without any further actions
-
-GitHub Repository
-------------------
-
-Clone DomHMM's repository and change directory to project directory
-
-.. code-block::
-
-    git clone https://github.com/BioMemPhys-FAU/domhmm
-    cd domhmm
 
 Environment Creation
 ---------------------
@@ -28,16 +16,30 @@ If you don't have any Python environment, you can create a conda environment by
 
     ``conda create`` command creates a conda environment named *domhmm* and ``conda activate`` command starts environment in your terminal. Whenever you close your terminal, you need to use activate command again to restart environment.
 
-After conda environment creation, you can install dependencies via
+
+Installation with PyPI
+-----------------------
+
+For installation, you can directly use pip in project directory.
 
 .. code-block:: console
 
-    pip install -e .
+   pip install domhmm
 
-Installation via pip
----------------------
 
-For direct installation, you can directly use pip in project directory.
+Installation for Development
+------------------------------
+
+This type of installation can be use when pip is not usable, change in source code or contributing DomHMM.
+
+Clone DomHMM's repository and change directory to project directory
+
+.. code-block::
+
+    git clone https://github.com/BioMemPhys-FAU/domhmm
+    cd domhmm
+
+Install dependencies and DomHMM's current version via pip command
 
 .. code-block:: console
 

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-  "setuptools >= 40.9.0",
+  "setuptools >= 61.0",
   "wheel",
 ]
 build-backend = "setuptools.build_meta"
@@ -55,3 +55,10 @@ minversion = "6.0"
 testpaths = [
     "domhmm/tests",
 ]
+
+[tool.versioneer]
+VCS = "git"
+style = "pep440"
+versionfile_source = "domhmm/_version.py"
+versionfile_build = "domhmm/_version.py"
+tag_prefix = ""

setup.py

@@ -39,7 +39,7 @@
     # Which Python importable modules should be included when your package is installed
     # Handled automatically by setuptools. Use 'exclude' to prevent some specific
     # subpackage(s) from being added, if needed
-    packages=find_packages(),
+    packages=find_packages() + ['domhmm.tests.data'],
 
     # Optional include package data to ship with your package
     # Customize MANIFEST.in if the general case does not suit your needs