Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Michiel Cottaar
fslpy
Commits
b81f222f
Commit
b81f222f
authored
Jun 06, 2017
by
Paul McCarthy
🚵
Browse files
README.md moved to README.rst, because pypi doesn't support md. Xvfb install
tweak
parent
066be4a6
Changes
5
Hide whitespace changes
Inline
Side-by-side
.gitlab-ci.yml
View file @
b81f222f
...
...
@@ -212,7 +212,7 @@ variables:
# Linux builds for wxPython are currently
# not on pypi, but are available at this
# url.
-
apt-get install xvfb
-
apt-get install
-y
xvfb
-
pip install -f https://wxpython.org/Phoenix/release-extras/linux/gtk3/debian-8/ wxpython
# All other deps can be installed as normal
...
...
MANIFEST.in
View file @
b81f222f
include LICENSE
include COPYRIGHT
include README.md
include requirements.txt
include pytest.ini
recursive-include doc *
...
...
README.md
deleted
100644 → 0
View file @
066be4a6
fslpy
=====
The
`fslpy`
project is a
[
FSL
](
http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/
)
programming library written in Python. It is used by
[
FSLeyes
](
https://git.fmrib.ox.ac.uk/paulmc/fsleyes/
)
.
Dependencies
------------
All of the dependencies of
`fslpy`
are listed in the
[
requirements.txt
](
requirements.txt
)
file. Some
`fslpy`
modules require
[
wxPython
](
http://www.wxpython.org
)
3.0.2.0.
Documentation
-------------
`fslpy`
is documented using
[
sphinx
](
http://http://sphinx-doc.org/
)
. You can
build the API documentation by running:
python setup.py doc
The HTML documentation will be generated and saved in the
`doc/html/`
directory.
If you are interested in contributing to
`fslpy`
, check out the
[
contributing
guide
](
doc/contributing.rst
)
.
Tests
-----
Run the test suite via:
python setup.py test
A test report will be generated at
`report.html`
, and a code coverage report
will be generated in
`htmlcov/`
.
README.rst
0 → 100644
View file @
b81f222f
fslpy
=====
The ``fslpy`` project is a `FSL <http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/>`_
programming library written in Python. It is used by `FSLeyes
<https://git.fmrib.ox.ac.uk/paulmc/fsleyes/>`_.
Dependencies
------------
All of the dependencies of ``fslpy`` are listed in the `requirements.txt
<requirements.txt>`_ file. Some ``fslpy`` modules require `wxPython
<http://www.wxpython.org>`_ 3.0.2.0 or higher.
Documentation
-------------
``fslpy`` is documented using `sphinx <http://http://sphinx-doc.org/>`_. You
can build the API documentation by running::
python setup.py doc
The HTML documentation will be generated and saved in the ``doc/html/``
directory.
If you are interested in contributing to ``fslpy``, check out the
`contributing guide <doc/contributing.rst>`_.
Tests
-----
Run the test suite via::
python setup.py test
A test report will be generated at ``report.html``, and a code coverage report
will be generated in ``htmlcov/``.
setup.py
View file @
b81f222f
...
...
@@ -37,7 +37,7 @@ with open(op.join(basedir, "fsl", "version.py")) as f:
break
version
=
version
[
'__version__'
]
with
open
(
op
.
join
(
basedir
,
'README.
md
'
),
'rt'
)
as
f
:
with
open
(
op
.
join
(
basedir
,
'README.
rst
'
),
'rt'
)
as
f
:
readme
=
f
.
read
()
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment