Skip to content

Commit

Permalink
add changelog and docs to pyproject, correct installation
Browse files Browse the repository at this point in the history
  • Loading branch information
h-mayorquin committed Dec 11, 2024
1 parent 972cbcd commit f0b30c5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
16 changes: 11 additions & 5 deletions docs/source/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,23 @@ Installation
$ pip install roiextractors
#. You can check for any missing packages by explicitly installing from the `requirements <https://github.com/catalystneuro/roiextractors/blob/master/requirements.txt/>`_ file:
.. code-block:: shell
$ pip install -r requirements.txt
#. **Cloning the github repo**:
.. code-block:: shell
$ git clone https://github.com/SpikeInterface/spikeinterface.git
$ cd spikeinterface
$ python setup.py install (or develop)
$ pip install --editable .
You can also install the optional dependencies by installing the package with the following command:

.. code-block:: shell
$ pip install "roiextractors[full]"
$ pip install "roiextractors[test]"
$ pip install "roiextractors[docs]"
These commands install the full, test, and documentation dependencies, respectively.

What is RoiExtractors
---------------------
Expand Down
7 changes: 6 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@ classifiers = [
"Operating System :: MacOS",
"License :: OSI Approved :: BSD License",
]
urls = { Homepage = "https://github.com/catalystneuro/roiextractors" }
urls = { Homepage = }

[project.urls]
"Homepage" = "https://github.com/catalystneuro/roiextractors"
"Documentation" = "https://roiextractors.readthedocs.io//"
"Changelog" = "https://github.com/catalystneuro/roiextractors/blob/main/CHANGELOG.md"

requires-python = ">=3.9"

Expand Down

0 comments on commit f0b30c5

Please sign in to comment.