Merge branch 'rewrite_object_oriented' into main

.github/workflows/tests.yml

@@ -28,16 +28,16 @@ jobs:
     
     - name: Check formatting with black
       run: |
-        black --check py_ephys tests
+        black --check ephyspy tests
     
     - name: Check imports with isort
       run: |
-        isort -c py_ephys tests
+        isort -c ephyspy tests
 
 # add pyright at some point!
 #    - name: Check types with pyright
 #      run: |
-#        pyright py_ephys
+#        pyright ephyspy
 
     - name: Test with pytest
       run: |

CONTRIBUTING.md

@@ -1,10 +1,10 @@
 ## Issues
 
-Bug reports and requests for features should be made via the [issues](https://github.com/mackelab/py_ephys/issues).
+Bug reports and requests for features should be made via the [issues](https://github.com/mackelab/ephyspy/issues).
 
 ## Code contributions
 
-If you want to contribute to this package yourself, please fork, create a feature branch and then make a PR from your feature branch to the upstream `py_ephys` ([see here for details](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)).
+If you want to contribute to this package yourself, please fork, create a feature branch and then make a PR from your feature branch to the upstream `ephyspy` ([see here for details](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)).
 
 ### Development environment
 
@@ -14,7 +14,7 @@ You can install via `setup.py` using `pip install -e ".[dev]"` (the dev flag ins
 
 For docstrings and comments, please adhere to [Google Style](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
 
-Code needs to pass through the following tools, which are installed alongside `py_ephys`:
+Code needs to pass through the following tools, which are installed alongside `ephyspy`:
 
 **[black](https://github.com/psf/black)**: Automatic code formatting for Python. You can
 run black manually from the console using `black .` in the top directory of the

README.md

@@ -1,17 +1,18 @@
 <!-- [![PyPI version]()]() -->
 <!-- [![codecov]()]() -->
 <!-- [![DOI]()]() -->
-[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/berenslab/py_ephys/blob/main/CONTRIBUTING.md)
-[![Tests](https://github.com/berenslab/py_ephys/workflows/Tests/badge.svg?branch=main)](https://github.com/berenslab/py_ephys/actions)
-[![GitHub license](https://img.shields.io/github/license/berenslab/py_ephys)](https://github.com/berenslab/py_ephys/blob/main/LICENSE.txt)
+[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/berenslab/ephyspy/blob/main/CONTRIBUTING.md)
+[![Tests](https://github.com/berenslab/ephyspy/workflows/Tests/badge.svg?branch=main)](https://github.com/berenslab/ephyspy/actions)
+[![GitHub license](https://img.shields.io/github/license/berenslab/ephyspy)](https://github.com/berenslab/ephyspy/blob/main/LICENSE.txt)
 
+# EphysPy
 
 ### Package to extract electrophysiological features from current clamp experiments.
 
 This package provies an API to extract a multitude of features from voltage clamp recordings with the help of the [AllenSDK](https://allensdk.readthedocs.io/en/latest/allensdk.ephys.html). 
 
 ### Installation
-Clone the package with `https://github.com/berenslab/py_ephys.git` and install using pip via `pip install -e ./py_ephys`.
+Clone the package with `https://github.com/berenslab/ephyspy.git` and install using pip via `pip install -e ./ephyspy`.
 
 ### Getting started
 To get started see [`example.ipynb`](./example.ipynb).