Prepare for publishing

README.md

@@ -32,10 +32,17 @@ To install the latest delevopment version, first clone this repository:
 $ git clone https://github.com/richardkoehler/pte-stats
 ```
 
-Then install with the command:
+If you are using conda, simply run:
 
 ```bash
-$ pip install .
+$ conda env create -f env.yml
+$ conda activate pte-stats
+```
+
+If you want to install pte-stats into an existing environment, type:
+
+```bash
+$ pip install -e .
 ```
 
 
@@ -56,9 +63,16 @@ For any minor additions or bugfixes, you may simply create a **pull request**.
 For any major changes, make sure to open an **issue** first. When you then create a pull request, be sure to **link the pull request** to the open issue in order to close the issue automatically after merging.
 
 ### How to contribute
-To contribute yourselves, you should fork this repository, and create your a development branch from your fork.
+To contribute yourselves, you should fork this repository, and then create a development branch from your fork.
+
+Then, inside your development branch run the commands:
+
+```bash
+$ conda env create -f env_dev.yml
+$ conda activate pte-stats-dev
+```
 
-Then, inside your development branch run the command:
+... or simply:
 
 ```bash
 $ pip install -e .[dev]
@@ -71,9 +85,9 @@ PTE Stats is licensed under the [MIT license](license-url).
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-[python-shield]: https://img.shields.io/static/v1?label=Python&message=3.9|3.10&logoColor=black&labelColor=grey&color=blue
+[python-shield]: https://img.shields.io/static/v1?label=Python&message=3.10&logoColor=black&labelColor=grey&color=blue
 [python-url]: https://pypi.org/project/pte-stats/
-[pypi-shield]: https://img.shields.io/static/v1?label=PyPi&message=v0.1.0&logoColor=black&labelColor=grey&color=blue
+[pypi-shield]: https://img.shields.io/static/v1?label=PyPi&message=v0.2.0&logoColor=black&labelColor=grey&color=blue
 [pypi-url]: https://pypi.org/project/pte-stats/
 [tests-shield]: https://github.com/richardkoehler/pte-stats/actions/workflows/tests.yml/badge.svg
 [tests-url]: https://github.com/richardkoehler/pte-stats/actions/workflows/tests.yml

env.yml

@@ -1,13 +1,8 @@
 name: pte-stats
 channels:
-  - conda-forge
   - defaults
 dependencies:
-  - joblib
-  - numba
-  - numpy
   - pip
-  - python>=3.9
-  - scikit-image
-  - statsmodels
-
+  - python=3.10
+  - pip:
+    - -e .

env_dev.yml

@@ -2,20 +2,8 @@ name: pte-stats-dev
 channels:
   - defaults
 dependencies:
-  - python>=3.9
   - pip
+  - python=3.10
   - pip:
-    # basic dependencies
-    - joblib
-    - numba
-    - numpy
-    - scikit-image
-    - statsmodels
-    # development dependencies
-    - black
-    - isort
-    - mypy
-    - pylint
-    - pytest
-    - pytest-cov
+    - -e .[dev]
 

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["flit_core >=3.5,<4"]
 
 [project]
 authors = [
-  {name = "Richard Köhler"},
+  {name = "Richard M. Köhler"},
 ]
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
@@ -15,9 +15,9 @@ classifiers = [
 description = "An open-source software package for statistics with time series."
 dynamic = ["version"]
 keywords = ["statistics", "timeseries", "eeg", "ieeg"]
-license = {file = "LICENSE.txt"}
+license = {file = "LICENSE"}
 maintainers = [
-  {name = "Richard Köhler"},
+  {name = "Richard M. Köhler"},
 ]
 name = "pte-stats"
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -31,9 +31,6 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-deploy = [
-  "flit",
-]
 dev = [
   "black",
   "isort",

src/pte_stats/__init__.py

@@ -1,6 +1,6 @@
 """An open-source software package for statistics with time series. """
 
-__version__ = "0.2.0.dev1"
+__version__ = "0.2.0"
 
 from .cluster import (
     cluster_analysis_1d,