Debian Codegraph @

INSTALL

raw
1 #######
2 Install
3 #######
4
5 .. note::
6
7 If you want to install a development environment, please see
8 :doc:`/contributing`.
9
10
11 ************
12 Requirements
13 ************
14
15 `django-downloadview` has been tested with `Python`_ 3.7, 3.8, 3.9 and 3.10.
16 Other versions may work, but they are not part of the test suite at the moment.
17
18 Installing `django-downloadview` will automatically trigger the installation of
19 the following requirements:
20
21 .. literalinclude:: /../setup.py
22 :language: python
23 :start-after: BEGIN requirements
24 :end-before: END requirements
25
26
27 ************
28 As a library
29 ************
30
31 In most cases, you will use `django-downloadview` as a dependency of another
32 project. In such a case, you should add `django-downloadview` in your main
33 project's requirements. Typically in :file:`setup.py`:
34
35 .. code:: python
36
37 from setuptools import setup
38
39 setup(
40 install_requires=[
41 'django-downloadview',
42 #...
43 ]
44 # ...
45 )
46
47 Then when you install your main project with your favorite package manager
48 (like `pip`_), `django-downloadview` and its recursive dependencies will
49 automatically be installed.
50
51
52 **********
53 Standalone
54 **********
55
56 You can install `django-downloadview` with your favorite Python package
57 manager. As an example with `pip`_:
58
59 .. code:: sh
60
61 pip install django-downloadview
62
63
64 *****
65 Check
66 *****
67
68 Check `django-downloadview` has been installed:
69
70 .. code:: sh
71
72 python -c "import django_downloadview;print(django_downloadview.__version__)"
73
74 You should get installed `django-downloadview`'s version.
75
76
77 .. rubric:: Notes & references
78
79 .. seealso::
80
81 * :doc:`/settings`
82 * :doc:`/about/changelog`
83 * :doc:`/about/license`
84
85 .. target-notes::
86
87 .. _`Python`: https://www.python.org/
88 .. _`pip`: https://pip.pypa.io/