django-downloadview/INSTALL
2022-08-04 09:22:28 -04:00

88 lines
1.7 KiB
Text

#######
Install
#######
.. note::
If you want to install a development environment, please see
:doc:`/contributing`.
************
Requirements
************
`django-downloadview` has been tested with `Python`_ 3.7, 3.8, 3.9 and 3.10.
Other versions may work, but they are not part of the test suite at the moment.
Installing `django-downloadview` will automatically trigger the installation of
the following requirements:
.. literalinclude:: /../setup.py
:language: python
:start-after: BEGIN requirements
:end-before: END requirements
************
As a library
************
In most cases, you will use `django-downloadview` as a dependency of another
project. In such a case, you should add `django-downloadview` in your main
project's requirements. Typically in :file:`setup.py`:
.. code:: python
from setuptools import setup
setup(
install_requires=[
'django-downloadview',
#...
]
# ...
)
Then when you install your main project with your favorite package manager
(like `pip`_), `django-downloadview` and its recursive dependencies will
automatically be installed.
**********
Standalone
**********
You can install `django-downloadview` with your favorite Python package
manager. As an example with `pip`_:
.. code:: sh
pip install django-downloadview
*****
Check
*****
Check `django-downloadview` has been installed:
.. code:: sh
python -c "import django_downloadview;print(django_downloadview.__version__)"
You should get installed `django-downloadview`'s version.
.. rubric:: Notes & references
.. seealso::
* :doc:`/settings`
* :doc:`/about/changelog`
* :doc:`/about/license`
.. target-notes::
.. _`Python`: https://www.python.org/
.. _`pip`: https://pip.pypa.io/