Skip to content


Repository files navigation

pyNS 🌲

Python package codecov docs

pyNS is a python library to easily interact with the Neuroscout API.

pyNS enables advanced used cases not supported by the web-based analysis builder, such as batch-creation of analyses, meta-analytic applications, as well as supporting the operations of the neuroscout-cli


Use pip to install it:

pip install pyns

Documentation 📚

Full documentation can be found at readthedocs.

For API docs, check out the Swagger API UI.

For a tutorial see this jupyter notebook example.
You can also follow the Neuroscout Paper's analyses in this interactive jupyter book.


We use pytest for testing, and betamax to record HTTP requests used in tests.
To re-run tests locally set theUSER_TEST_EMAIL and USER_TEST_PWD environment variables with valid API credentials.