urlman 2.0.2__tar.gz → 2.0.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
urlman-2.0.3/PKG-INFO ADDED
@@ -0,0 +1,265 @@
1
+ Metadata-Version: 2.2
2
+ Name: urlman
3
+ Version: 2.0.3
4
+ Summary: Django URL pattern helpers
5
+ Author-email: Andrew Godwin <andrew@aeracode.org>
6
+ License: Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the purposes
49
+ of this License, Derivative Works shall not include works that remain
50
+ separable from, or merely link (or bind by name) to the interfaces of,
51
+ the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including
54
+ the original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing the
146
+ origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ Project-URL: Homepage, https://github.com/andrewgodwin/urlman
184
+ Classifier: Development Status :: 5 - Production/Stable
185
+ Classifier: Framework :: Django
186
+ Classifier: Operating System :: OS Independent
187
+ Requires-Python: >=3.6
188
+ Description-Content-Type: text/x-rst
189
+ License-File: LICENSE
190
+
191
+ urlman
192
+ ------
193
+
194
+ .. image:: https://travis-ci.org/andrewgodwin/urlman.svg?branch=master
195
+ :target: https://travis-ci.org/andrewgodwin/urlman
196
+ :alt: Test Status
197
+
198
+ .. image:: https://codecov.io/gh/andrewgodwin/urlman/branch/master/graph/badge.svg
199
+ :target: https://codecov.io/gh/andrewgodwin/urlman
200
+ :alt: Test Coverage Status
201
+
202
+ A nicer way to do URLs for Django models.
203
+
204
+ Replaces things like ``get_absolute_url`` with a ``.urls`` attribute that
205
+ can reference other URLs and build sensible trees of things, and can
206
+ then be accessed using ``instance.urls.name``.
207
+
208
+ This is so you can have URLs on your model instances directly (rather than reversing
209
+ through the url lookup functions, which is not only slow but often hard to supply
210
+ arguments to). You can just throw ``{{ instance.urls.view }}`` into a template to get
211
+ a link.
212
+
213
+ It also lets you use Python string formatting syntax to place arguments into URLs from
214
+ the model instance itself or from other URLs in the same set.
215
+
216
+ Example:
217
+
218
+ .. code-block:: python
219
+
220
+ import urlman
221
+
222
+ class Group(models.Model):
223
+
224
+ ...
225
+
226
+ class urls(urlman.Urls):
227
+ view = "/{self.slug}/"
228
+ users = "{view}users/"
229
+ admin = "{view}admin/"
230
+
231
+
232
+ def my_view(request):
233
+ group = ...
234
+ return redirect(group.urls.view)
235
+
236
+ It's suggested that you use "view" as the equivalent name for
237
+ ``get_absolute_url``, and have a function like this on your model:
238
+
239
+ .. code-block:: python
240
+
241
+ def get_absolute_url(self):
242
+ return self.urls.view
243
+
244
+ To build a full URL use the ``full`` method like this:
245
+
246
+ .. code-block:: python
247
+
248
+ def my_view(request):
249
+ group = ...
250
+ return redirect(group.urls.admin.full(scheme='https'))
251
+
252
+ You can implement the `get_scheme(url)` and `get_hostname(url)` methods on your
253
+ `Url` class to change your default theme and hostname from the urlman defaults
254
+ of `'http'` and `'localhost'`, respectively.
255
+
256
+ If you use Django REST Framework, you can use ``urlman.UrlManField`` to provide
257
+ an object with a set of URLs. It is used like this (only the ``urls`` parameter
258
+ is required):
259
+
260
+ .. code-block:: python
261
+
262
+ from urlman.serializers import UrlManField
263
+
264
+ class MySerializer(ModelSerializer):
265
+ urls = UrlManField(urls=['view', 'edit'], attribute='urls', full=True)
@@ -0,0 +1,20 @@
1
+ [project]
2
+ name = "urlman"
3
+ version = "2.0.3"
4
+ authors = [{ name = "Andrew Godwin", email = "andrew@aeracode.org" }]
5
+ description = "Django URL pattern helpers"
6
+ readme = "README.rst"
7
+ requires-python = ">=3.6"
8
+ classifiers = [
9
+ "Development Status :: 5 - Production/Stable",
10
+ "Framework :: Django",
11
+ "Operating System :: OS Independent",
12
+ ]
13
+ license = { file = "LICENSE" }
14
+
15
+ [project.urls]
16
+ Homepage = "https://github.com/andrewgodwin/urlman"
17
+
18
+ [build-system]
19
+ requires = ["setuptools ~= 76.0"]
20
+ build-backend = "setuptools.build_meta"
@@ -6,7 +6,7 @@ except ImportError: # pragma: no cover
6
6
  from urllib.parse import urlunparse
7
7
 
8
8
 
9
- __version__ = "2.0.2"
9
+ __version__ = "2.0.3"
10
10
 
11
11
 
12
12
  class UrlsMetaclass(type):
@@ -45,6 +45,9 @@ class Urls(metaclass=UrlsMetaclass):
45
45
  self.context = {"self": self.instance}
46
46
  self.context.update(self.urls)
47
47
  self.__qualname__ = ".".join((klass.__qualname__, name))
48
+ self.__objclass__ = klass
49
+ self.__name__ = name
50
+ self.__wrapped__ = None
48
51
 
49
52
  def __getattr__(self, attr):
50
53
  return self.get_url(attr)
@@ -3,7 +3,8 @@ try:
3
3
  except ImportError: # pragma: no cover
4
4
 
5
5
  class Field:
6
- pass
6
+ def __init__(self, **kwargs):
7
+ pass
7
8
 
8
9
 
9
10
  class UrlManField(Field):
@@ -22,8 +23,8 @@ class UrlManField(Field):
22
23
  def to_representation(self, value):
23
24
  url_class = getattr(value, self.url_attribute)
24
25
  return {
25
- url: getattr(url_class, url).full()
26
- if self.full
27
- else getattr(url_class, url)
26
+ url: (
27
+ getattr(url_class, url).full() if self.full else getattr(url_class, url)
28
+ )
28
29
  for url in self.urls
29
30
  }
@@ -0,0 +1,265 @@
1
+ Metadata-Version: 2.2
2
+ Name: urlman
3
+ Version: 2.0.3
4
+ Summary: Django URL pattern helpers
5
+ Author-email: Andrew Godwin <andrew@aeracode.org>
6
+ License: Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the purposes
49
+ of this License, Derivative Works shall not include works that remain
50
+ separable from, or merely link (or bind by name) to the interfaces of,
51
+ the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including
54
+ the original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing the
146
+ origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ Project-URL: Homepage, https://github.com/andrewgodwin/urlman
184
+ Classifier: Development Status :: 5 - Production/Stable
185
+ Classifier: Framework :: Django
186
+ Classifier: Operating System :: OS Independent
187
+ Requires-Python: >=3.6
188
+ Description-Content-Type: text/x-rst
189
+ License-File: LICENSE
190
+
191
+ urlman
192
+ ------
193
+
194
+ .. image:: https://travis-ci.org/andrewgodwin/urlman.svg?branch=master
195
+ :target: https://travis-ci.org/andrewgodwin/urlman
196
+ :alt: Test Status
197
+
198
+ .. image:: https://codecov.io/gh/andrewgodwin/urlman/branch/master/graph/badge.svg
199
+ :target: https://codecov.io/gh/andrewgodwin/urlman
200
+ :alt: Test Coverage Status
201
+
202
+ A nicer way to do URLs for Django models.
203
+
204
+ Replaces things like ``get_absolute_url`` with a ``.urls`` attribute that
205
+ can reference other URLs and build sensible trees of things, and can
206
+ then be accessed using ``instance.urls.name``.
207
+
208
+ This is so you can have URLs on your model instances directly (rather than reversing
209
+ through the url lookup functions, which is not only slow but often hard to supply
210
+ arguments to). You can just throw ``{{ instance.urls.view }}`` into a template to get
211
+ a link.
212
+
213
+ It also lets you use Python string formatting syntax to place arguments into URLs from
214
+ the model instance itself or from other URLs in the same set.
215
+
216
+ Example:
217
+
218
+ .. code-block:: python
219
+
220
+ import urlman
221
+
222
+ class Group(models.Model):
223
+
224
+ ...
225
+
226
+ class urls(urlman.Urls):
227
+ view = "/{self.slug}/"
228
+ users = "{view}users/"
229
+ admin = "{view}admin/"
230
+
231
+
232
+ def my_view(request):
233
+ group = ...
234
+ return redirect(group.urls.view)
235
+
236
+ It's suggested that you use "view" as the equivalent name for
237
+ ``get_absolute_url``, and have a function like this on your model:
238
+
239
+ .. code-block:: python
240
+
241
+ def get_absolute_url(self):
242
+ return self.urls.view
243
+
244
+ To build a full URL use the ``full`` method like this:
245
+
246
+ .. code-block:: python
247
+
248
+ def my_view(request):
249
+ group = ...
250
+ return redirect(group.urls.admin.full(scheme='https'))
251
+
252
+ You can implement the `get_scheme(url)` and `get_hostname(url)` methods on your
253
+ `Url` class to change your default theme and hostname from the urlman defaults
254
+ of `'http'` and `'localhost'`, respectively.
255
+
256
+ If you use Django REST Framework, you can use ``urlman.UrlManField`` to provide
257
+ an object with a set of URLs. It is used like this (only the ``urls`` parameter
258
+ is required):
259
+
260
+ .. code-block:: python
261
+
262
+ from urlman.serializers import UrlManField
263
+
264
+ class MySerializer(ModelSerializer):
265
+ urls = UrlManField(urls=['view', 'edit'], attribute='urls', full=True)
@@ -1,7 +1,7 @@
1
1
  LICENSE
2
2
  README.rst
3
+ pyproject.toml
3
4
  setup.cfg
4
- setup.py
5
5
  urlman/__init__.py
6
6
  urlman/serializers.py
7
7
  urlman.egg-info/PKG-INFO
urlman-2.0.2/PKG-INFO DELETED
@@ -1,100 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: urlman
3
- Version: 2.0.2
4
- Summary: Django URL pattern helpers
5
- Home-page: https://github.com/andrewgodwin/urlman
6
- Author: Andrew Godwin
7
- Author-email: andrew@aeracode.org
8
- Classifier: Development Status :: 5 - Production/Stable
9
- Classifier: Framework :: Django
10
- Classifier: License :: OSI Approved :: Apache Software License
11
- Classifier: Programming Language :: Python
12
- Classifier: Programming Language :: Python :: 2
13
- Classifier: Programming Language :: Python :: 2.7
14
- Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.4
16
- Classifier: Programming Language :: Python :: 3.5
17
- Classifier: Programming Language :: Python :: 3.6
18
- Classifier: Programming Language :: Python :: 3.7
19
- Classifier: Programming Language :: Python :: 3.8
20
- Classifier: Programming Language :: Python :: 3.9
21
- Classifier: Programming Language :: Python :: Implementation :: CPython
22
- Classifier: Programming Language :: Python :: Implementation :: PyPy
23
- Classifier: Operating System :: OS Independent
24
- License-File: LICENSE
25
-
26
- urlman
27
- ------
28
-
29
- .. image:: https://travis-ci.org/andrewgodwin/urlman.svg?branch=master
30
- :target: https://travis-ci.org/andrewgodwin/urlman
31
- :alt: Test Status
32
-
33
- .. image:: https://codecov.io/gh/andrewgodwin/urlman/branch/master/graph/badge.svg
34
- :target: https://codecov.io/gh/andrewgodwin/urlman
35
- :alt: Test Coverage Status
36
-
37
- A nicer way to do URLs for Django models.
38
-
39
- Replaces things like ``get_absolute_url`` with a ``.urls`` attribute that
40
- can reference other URLs and build sensible trees of things, and can
41
- then be accessed using ``instance.urls.name``.
42
-
43
- This is so you can have URLs on your model instances directly (rather than reversing
44
- through the url lookup functions, which is not only slow but often hard to supply
45
- arguments to). You can just throw ``{{ instance.urls.view }}`` into a template to get
46
- a link.
47
-
48
- It also lets you use Python string formatting syntax to place arguments into URLs from
49
- the model instance itself or from other URLs in the same set.
50
-
51
- Example:
52
-
53
- .. code-block:: python
54
-
55
- import urlman
56
-
57
- class Group(models.Model):
58
-
59
- ...
60
-
61
- class urls(urlman.Urls):
62
- view = "/{self.slug}/"
63
- users = "{view}users/"
64
- admin = "{view}admin/"
65
-
66
-
67
- def my_view(request):
68
- group = ...
69
- return redirect(group.urls.view)
70
-
71
- It's suggested that you use "view" as the equivalent name for
72
- ``get_absolute_url``, and have a function like this on your model:
73
-
74
- .. code-block:: python
75
-
76
- def get_absolute_url(self):
77
- return self.urls.view
78
-
79
- To build a full URL use the ``full`` method like this:
80
-
81
- .. code-block:: python
82
-
83
- def my_view(request):
84
- group = ...
85
- return redirect(group.urls.admin.full(scheme='https'))
86
-
87
- You can implement the `get_scheme(url)` and `get_hostname(url)` methods on your
88
- `Url` class to change your default theme and hostname from the urlman defaults
89
- of `'http'` and `'localhost'`, respectively.
90
-
91
- If you use Django REST Framework, you can use ``urlman.UrlManField`` to provide
92
- an object with a set of URLs. It is used like this (only the ``urls`` parameter
93
- is required):
94
-
95
- .. code-block:: python
96
-
97
- from urlman.serializers import UrlManField
98
-
99
- class MySerializer(ModelSerializer):
100
- urls = UrlManField(urls=['view', 'edit'], attribute='urls', full=True)
urlman-2.0.2/setup.py DELETED
@@ -1,34 +0,0 @@
1
- import os
2
- from setuptools import setup
3
-
4
- with open(os.path.join(os.path.dirname(__file__), "README.rst")) as fh:
5
- readme_content = fh.read()
6
-
7
- setup(
8
- name="urlman",
9
- version="2.0.2",
10
- description="Django URL pattern helpers",
11
- long_description=readme_content,
12
- url="https://github.com/andrewgodwin/urlman",
13
- packages=["urlman"],
14
- author="Andrew Godwin",
15
- author_email="andrew@aeracode.org",
16
- classifiers=[
17
- "Development Status :: 5 - Production/Stable",
18
- "Framework :: Django",
19
- "License :: OSI Approved :: Apache Software License",
20
- "Programming Language :: Python",
21
- "Programming Language :: Python :: 2",
22
- "Programming Language :: Python :: 2.7",
23
- "Programming Language :: Python :: 3",
24
- "Programming Language :: Python :: 3.4",
25
- "Programming Language :: Python :: 3.5",
26
- "Programming Language :: Python :: 3.6",
27
- "Programming Language :: Python :: 3.7",
28
- "Programming Language :: Python :: 3.8",
29
- "Programming Language :: Python :: 3.9",
30
- "Programming Language :: Python :: Implementation :: CPython",
31
- "Programming Language :: Python :: Implementation :: PyPy",
32
- "Operating System :: OS Independent",
33
- ],
34
- )
@@ -1,100 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: urlman
3
- Version: 2.0.2
4
- Summary: Django URL pattern helpers
5
- Home-page: https://github.com/andrewgodwin/urlman
6
- Author: Andrew Godwin
7
- Author-email: andrew@aeracode.org
8
- Classifier: Development Status :: 5 - Production/Stable
9
- Classifier: Framework :: Django
10
- Classifier: License :: OSI Approved :: Apache Software License
11
- Classifier: Programming Language :: Python
12
- Classifier: Programming Language :: Python :: 2
13
- Classifier: Programming Language :: Python :: 2.7
14
- Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.4
16
- Classifier: Programming Language :: Python :: 3.5
17
- Classifier: Programming Language :: Python :: 3.6
18
- Classifier: Programming Language :: Python :: 3.7
19
- Classifier: Programming Language :: Python :: 3.8
20
- Classifier: Programming Language :: Python :: 3.9
21
- Classifier: Programming Language :: Python :: Implementation :: CPython
22
- Classifier: Programming Language :: Python :: Implementation :: PyPy
23
- Classifier: Operating System :: OS Independent
24
- License-File: LICENSE
25
-
26
- urlman
27
- ------
28
-
29
- .. image:: https://travis-ci.org/andrewgodwin/urlman.svg?branch=master
30
- :target: https://travis-ci.org/andrewgodwin/urlman
31
- :alt: Test Status
32
-
33
- .. image:: https://codecov.io/gh/andrewgodwin/urlman/branch/master/graph/badge.svg
34
- :target: https://codecov.io/gh/andrewgodwin/urlman
35
- :alt: Test Coverage Status
36
-
37
- A nicer way to do URLs for Django models.
38
-
39
- Replaces things like ``get_absolute_url`` with a ``.urls`` attribute that
40
- can reference other URLs and build sensible trees of things, and can
41
- then be accessed using ``instance.urls.name``.
42
-
43
- This is so you can have URLs on your model instances directly (rather than reversing
44
- through the url lookup functions, which is not only slow but often hard to supply
45
- arguments to). You can just throw ``{{ instance.urls.view }}`` into a template to get
46
- a link.
47
-
48
- It also lets you use Python string formatting syntax to place arguments into URLs from
49
- the model instance itself or from other URLs in the same set.
50
-
51
- Example:
52
-
53
- .. code-block:: python
54
-
55
- import urlman
56
-
57
- class Group(models.Model):
58
-
59
- ...
60
-
61
- class urls(urlman.Urls):
62
- view = "/{self.slug}/"
63
- users = "{view}users/"
64
- admin = "{view}admin/"
65
-
66
-
67
- def my_view(request):
68
- group = ...
69
- return redirect(group.urls.view)
70
-
71
- It's suggested that you use "view" as the equivalent name for
72
- ``get_absolute_url``, and have a function like this on your model:
73
-
74
- .. code-block:: python
75
-
76
- def get_absolute_url(self):
77
- return self.urls.view
78
-
79
- To build a full URL use the ``full`` method like this:
80
-
81
- .. code-block:: python
82
-
83
- def my_view(request):
84
- group = ...
85
- return redirect(group.urls.admin.full(scheme='https'))
86
-
87
- You can implement the `get_scheme(url)` and `get_hostname(url)` methods on your
88
- `Url` class to change your default theme and hostname from the urlman defaults
89
- of `'http'` and `'localhost'`, respectively.
90
-
91
- If you use Django REST Framework, you can use ``urlman.UrlManField`` to provide
92
- an object with a set of URLs. It is used like this (only the ``urls`` parameter
93
- is required):
94
-
95
- .. code-block:: python
96
-
97
- from urlman.serializers import UrlManField
98
-
99
- class MySerializer(ModelSerializer):
100
- urls = UrlManField(urls=['view', 'edit'], attribute='urls', full=True)
File without changes
File without changes
File without changes