aboutsummaryrefslogtreecommitdiffstats
path: root/pkg_resources.txt
blob: f7a17bd6d5f7fa356a39ad25f9c569b2696c8185 (plain)
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
=============================================================
Package Discovery and Resource Access using ``pkg_resources``
=============================================================

The ``pkg_resources`` module, distributed with ``setuptools``, provides
features for Python libraries to access resource files, and for extensible
applications and frameworks to automatically discover plugins.  It also
provides runtime support for using C extensions that are inside zipfile
eggs, support for merging packages that have separately-distributed modules or
subpackages, and APIs for managing Python's current "working set" of active
packages.


.. contents:: **Table of Contents**


--------
Overview
--------

XXX


-----------------
Developer's Guide
-----------------

    Accessing Resources
    Finding and Activating Package Distributions
        get_provider()
        require()
        WorkingSet
        iter_distributions
    Running Scripts
    Configuration
    Namespace Packages
    Extensible Applications and Frameworks
        Locating entry points
        Activation listeners
        Metadata access
        Extended Discovery and Installation
    Supporting Custom PEP 302 Implementations


-------------
API Reference
-------------


``WorkingSet`` Objects
======================

Listeners


``Environment`` Objects
=======================

XXX


``EntryPoint`` Objects
======================

XXX


``Requirement`` Objects
=======================

XXX Syntax, parse_requirments, Requirement.parse, etc.


``Distribution`` Objects
========================

XXX


``ResourceManager`` Objects
===========================

XXX


Exceptions
==========

XXX ResolutionError, VersionConflict, DistributionNotFound, UnknownExtra


Utility Functions
=================


Parsing Utilities
-----------------

yield_lines
    XXX

split_sections
    XXX

parse_version
    XXX

safe_name
    XXX

safe_version
    XXX


Platform Utilities
------------------

get_platform
    XXX

compatible_platforms
    XXX


File/Path Utilities
-------------------

ensure_directory
    XXX

normalize_path
    XXX