pyxnat
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). However, some tests could not run due to restricted permissions. In v1.1, tests were restructured to use two independent XNAT instances based on permission level.
A public XNAT instance (NITRC/IR) is used for most tests with read access, while tests requiring write permissions run against a local XNAT instance in a Docker container.
Running the test suite requires the following:
pytest v7.1+
coverage v3.6+
docker v18+
A local Docker-powered XNAT instance can be set up using docker-compose and any available recipe. We recommend the one maintained by the XNAT team (xnat-docker-compose). Once the repository is cloned, run:
docker-compose up -d
After a couple of minutes, the XNAT instance should be up and running locally at http://localhost.
Finally run the tests from the root of the project:
pytest --cov pyxnat
See .github/workflows/ci.yml (used for CI) for the full test setup.
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
Release files for bbrc-pyxnat 1.6.4.post3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| bbrc_pyxnat-1.6.4.post3.tar.gz | 95.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bbrc_pyxnat-1.6.4.post3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 214.4 kB
Release files / bbrc_pyxnat-1.6.4.post3.tar.gz
| Download URL | bbrc_pyxnat-1.6.4.post3.tar.gz |
|---|---|
| Size | 95.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b2be4ac3d45508f1de0bb28621bdd8d6ce0d5e09850727867b316f7440fe1493
|
|
BLAKE2b-256 checksum How to use checksums |
87f2f37c140acfb03ab1624c87ceb45fdc98187fbc7f20e28b5c3bc70dcdffc8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.12
|
Release files / bbrc_pyxnat-1.6.4.post3-py3-none-any.whl
| Download URL | bbrc_pyxnat-1.6.4.post3-py3-none-any.whl |
|---|---|
| Size | 119.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
21e5775f255dfd8611855dd50d2b9aa097df60f1dafde9f91a235473f4a0e091
|
|
BLAKE2b-256 checksum How to use checksums |
5979a47b5b64f2b51555a9c1f2ef87f9508a3b9c037f96cd0ec75feaa4d9fed5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.12
|
Security for bbrc-pyxnat 1.6.4.post3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
