1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
.. _update_requirements_files:
================================
How to Update Requirements Files
================================
The different requirements files introduced in :ref:`software_process` section are the following:
* requirements.txt_
* requirements-dev.txt_
* requirements-doc.txt_
* requirements-min.txt_
* requirements-opt.txt_
.. _requirements.txt: https://github.com/hdmf-dev/hdmf/blob/dev/requirements.txt
.. _requirements-dev.txt: https://github.com/hdmf-dev/hdmf/blob/dev/requirements-dev.txt
.. _requirements-doc.txt: https://github.com/hdmf-dev/hdmf/blob/dev/requirements-doc.txt
.. _requirements-min.txt: https://github.com/hdmf-dev/hdmf/blob/dev/requirements-min.txt
.. _requirements-opt.txt: https://github.com/hdmf-dev/hdmf/blob/dev/requirements-opt.txt
requirements.txt
================
`requirements.txt` of the project can be created or updated and then captured using
the following script:
.. code::
mkvirtualenv hdmf-requirements
cd hdmf
pip install .
pip check # check for package conflicts
pip freeze > requirements.txt
deactivate
rmvirtualenv hdmf-requirements
requirements-(dev|doc|opt).txt
==============================
Any of these requirements files can be updated using
the following scripts:
.. code::
cd hdmf
# Set the requirements file to update
target_requirements=requirements-dev.txt
mkvirtualenv hdmf-requirements
# Install updated requirements
pip install -U -r $target_requirements
# If relevant, you could pip install new requirements now
# pip install -U <name-of-new-requirement>
# Check for any conflicts in installed packages
pip check
# Update list of pinned requirements
pip freeze > $target_requirements
deactivate
rmvirtualenv hdmf-requirements
requirements-min.txt
====================
Minimum requirements should be updated manually if a new feature or bug fix is added in a dependency that is required
for proper running of HDMF. Minimum requirements should also be updated if a user requests that HDMF be installable
with an older version of a dependency, all tests pass using the older version, and there is no valid reason for the
minimum version to be as high as it is.
|
