Skip to main content

XNAT in Python

Project description

https://github.com/pyxnat/pyxnat/actions/workflows/ci.yml/badge.svg https://coveralls.io/repos/github/pyxnat/pyxnat/badge.svg?branch=master https://img.shields.io/pypi/dm/pyxnat.svg https://img.shields.io/pypi/pyversions/pyxnat.svg https://img.shields.io/pypi/v/pyxnat.svg https://gitlab.com/xgrg/tweetit/-/raw/master/resources/008-pyxnat-v1.4.gif?inline=false

Where to get it

The source code is currently hosted on GitHub at: https://github.com/pyxnat/pyxnat

Binary installers for the latest released version are available at the Python package index. pyxnat can be installed using pip with the following command:

pip install pyxnat

Dependencies

  • requests v2.20 or higher

  • python-lxml v4.3.2 or higher recommended, earlier versions may work.

For development purposes:

See the full installation instructions for recommended and optional dependencies.

Installation from sources

To install pyxnat from source, from the pyxnat directory (same one where you found this file after cloning the git repo), execute:

python setup.py install

Documentation

The official documentation is hosted at: https://pyxnat.github.io/pyxnat

Running the test suite

Until v1.1 tests were exclusively performed on XNAT Central using a dedicated user account (nosetests). Yet some tests were not allowed to run due to restricted permissions. In v1.1, tests were restructured and were directed to two independent XNAT instances based on permission level. Hence XNAT Central is still used for most tests with read access whereas other tests requiring write permissions are run on a local XNAT instance in a Docker container.

Consequently, running the test suite now requires the following:

  • pytest v7.1+

  • coverage v3.6+

  • docker v18+

Setting up a local Docker-powered XNAT instance may be achieved easily using docker-compose and any available recipe. We recommend the one from the following repository (maintained by the XNAT team). Once the repository cloned, run the following command (possibly as sudo)

docker-compose up -d

After a couple of minutes, the XNAT instance should be up and running locally. You may check it out visiting http://localhost.

The script tests/setup_xnat.py may then be executed to populate the local instance before running the tests.

Finally run the tests with the following command (from the root of the project):

pytest --cov pyxnat

The file .github/workflows/ci.yml (used for CI) features these described steps and may be referred to for further information.

Building the documentation

Building the docs requires to have setuptools and sphinx (v2.0+) installed. Then run the command:

python setup.py build_sphinx

The docs are built in the build/sphinx/html folder.

Contribute to pyxnat

To contribute to pyxnat, first create an account on GitHub. Once this is done, fork the pyxnat repository to have you own repository, clone it using git clone on the computers where you want to work. Make changes in your clone, push them to your GitHub fork, test them on several computers and when you are happy with them, send a pull request to the main repository.

License

BSD 3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyxnat-1.6.3.tar.gz (82.5 kB view details)

Uploaded Source

Built Distribution

pyxnat-1.6.3-py3-none-any.whl (95.4 kB view details)

Uploaded Python 3

File details

Details for the file pyxnat-1.6.3.tar.gz.

File metadata

  • Download URL: pyxnat-1.6.3.tar.gz
  • Upload date:
  • Size: 82.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for pyxnat-1.6.3.tar.gz
Algorithm Hash digest
SHA256 ddd074f35f7b35b5dccb6f713b20cf083c79d6e0d3d9cafbcaabb7c661b0cc68
MD5 63ea1b8a706ffb3a4ad142967af22974
BLAKE2b-256 7f24c8737985e65d8adbbf51970b2a75cf54b5376d68d251159d9b7c5c9673b6

See more details on using hashes here.

File details

Details for the file pyxnat-1.6.3-py3-none-any.whl.

File metadata

  • Download URL: pyxnat-1.6.3-py3-none-any.whl
  • Upload date:
  • Size: 95.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for pyxnat-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a6d84dd24486eab9731a5de5df4fb486021b095665083c2fb1d33ac1e719d3c5
MD5 b59c0b656983be397b05c3dff6d81ef5
BLAKE2b-256 1cdf257c0f0af8e624daa924a3899f88e6465f162d72ada3fb0b96df9e61a2d6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page