File: lowlevel.rst

package info (click to toggle)
requirements-parser 0.11.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 564 kB
  • sloc: python: 360; makefile: 146
file content (45 lines) | stat: -rw-r--r-- 1,158 bytes parent folder | download
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
.. # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
   #     http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License.
   #
   # SPDX-License-Identifier: Apache-2.0

Low level API
=============

Higher Level Parsing
--------------------

Typically this is called via:

.. code-block:: python

     import requirements
     requirements.parse('django>=1.5')

.. automodule:: requirements.parser
    :members:

Lower Level Parsing
-------------------

Under the hood, the :class:`Requirement <requirements.requirement.Requirement>`
class does most of the heavy lifting.

.. automodule:: requirements.requirement
    :members:


Misc Functions
--------------

.. automodule:: requirements
    :members: