MNT release 0.1

Author: TomDLT

.gitignore

@@ -6,6 +6,8 @@
 .pytest_cache
 __pycache__
 .vscode/
+build/
+dist/
 
 # Documentation build
 doc/_build/

README.rst

@@ -19,7 +19,6 @@ To explore these tutorials, one can:
 
 - read the rendered examples in the tutorials
   `website <https://gallantlab.github.io/voxelwise_tutorials/>`_ (recommended)
-  (not online yet, ask Tom the local link)
 - run the Python scripts located in the `tutorials <tutorials>`_ directory
 - run the Jupyter notebooks located in the
   `tutorials/notebooks <tutorials/notebooks>`_ directory

setup.py

@@ -1,4 +1,5 @@
 import re
+from pathlib import Path
 from setuptools import find_packages, setup
 
 # get version from voxelwise_tutorials/__init__.py
@@ -10,6 +11,10 @@
         match = re.search(r"__version__ = '([^']*)'", line)
         __version__ = match.groups()[0]
 
+# read the contents of the README file
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.rst").read_text()
+
 requirements = [
     "numpy",
     "scipy",
@@ -19,8 +24,8 @@
     "networkx",
     "nltk",
     "pycortex",
-    "himalaya @ git+https://github.com/gallantlab/himalaya@main#egg=himalaya",
-    "pymoten @ git+https://github.com/gallantlab/pymoten@main#egg=pymoten",
+    "himalaya",
+    "pymoten",
 ]
 
 if __name__ == "__main__":
@@ -33,4 +38,6 @@
         version=__version__,
         packages=find_packages(),
         install_requires=requirements,
+        long_description=long_description,
+        long_description_content_type='text/x-rst',
     )

voxelwise_tutorials/__init__.py

@@ -1 +1 @@
-__version__ = '0.1'
+__version__ = '0.1.0'