change to pyproject.toml

change to pyproject.toml

README.md

@@ -7,12 +7,35 @@ Please see the [tutorial notebook](generatorpipeline-tutorial.ipynb) for an over
 
 
 # Installation
-Python 2 is NOT supported. You must use __python version 3.6__ or higher! Install using
+Python 2 is NOT supported. You must use __python version 3.6__ or higher! 
 
+1) The recommended way is to create a python venv and install it into the venv. Create a new virtualenv by
 ```
-pip install --user generatorpipeline[full]@git+https://github.com/skuschel/generatorpipeline.git
+python -m venv --system-site-packages ~/.venv/defaultpyvenv
 ```
 
+2) activate the environment using `source ~/.venv/defaultpyvenv/bin/activate`.
+
+3) Install into the venv
+```
+pip install generatorpipeline[full]@git+https://github.com/skuschel/generatorpipeline.git
+```
+
+# Installation for developers
+
+Follow steps 1 and 2 of the normal installation to create and activate a venv.
+
+3) git clone this repository
+```
+git clone git@github.com:skuschel/generatorpipeline.git
+```
+
+4) Install in editable mode using
+```
+pip install -e .
+```
+
+
 
 # Contributing
 ... is always welcome! Development and issue tracker can be found on github. Please report bugs to

pyproject.toml

+[build-system]
+requires = ["setuptools>=61.0", "setuptools-git-versioning", "versioneer[toml]==0.29"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "generatorpipeline"
+description = "Parallelize your data-processing pipelines with just a decorator."
+requires-python = ">=3.6"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Stephan Kuschel", email = "stephan.kuschel@gmail.com"},
+    ]
+dependencies = ["dill"]
+dynamic = ["version"]
+
+[tool.setuptools-git-versioning]
+enabled = true
+
+[project.urls]
+"Homepage" = "https://github.com/skuschel/generatorpipeline"
+"Bug Tracker" = "https://github.com/skuschel/generatorpipeline/issues"
+
+[project.optional-dependencies]
+network = ["pyzmq"]
+accumulators = ["numpy"]
+full = ["generatorpipeline[network,accumulators]"]
+
+[tool.versioneer]
+VCS = "git"
+style = "pep440"
+versionfile_source = "generatorpipeline/_version.py"
+versionfile_build = "generatorpipeline/_version.py"
+tag_prefix="v"
+parentdir_prefix = ""
\ No newline at end of file

setup.cfg

-[versioneer]
-VCS = git
-style = pep440
-versionfile_source = generatorpipeline/_version.py
-versionfile_build = generatorpipeline/_version.py
-tag_prefix =

setup.py

 #!/usr/bin/env python
 
-# Copyright (C) 2019-2020 Stephan Kuschel
+# Copyright (C) 2019-2023 Stephan Kuschel
 #
 # This file is part of generatorpipeline.
 #
@@ -21,18 +21,10 @@
 from setuptools import setup, find_packages
 import versioneer
 
+# keep setup.py for versioneer.
+# Otherwise git tags are ignored and `pip install .` doesnt know its version. See PR #46.
 
 setup(name='generatorpipeline',
       version=versioneer.get_version(),
       cmdclass=versioneer.get_cmdclass(),
-      packages=find_packages(include=['generatorpipeline*']),
-      python_requires='>=3.6',
-      license='GPLv3+',
-      author='Stephan Kuschel',
-      author_email='stephan.kuschel@gmail.com',
-      url='https://github.com/skuschel/generatorpipeline',
-      install_requires=['dill'],
-      extras_require={'network': ['pyzmq'],
-                      'accumulators': ['numpy'],
-                      'full': ['numpy', 'pyzmq']},
-      description='Parallelize your data-processing pipelines with just a decorator.')
+      packages=find_packages(include=['generatorpipeline*']))