Skip to content

Commit fe17693

Browse files
authored
Update README.md
1 parent 5c518ad commit fe17693

File tree

1 file changed

+32
-29
lines changed

1 file changed

+32
-29
lines changed

README.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Nested-multipart-parser
22

3+
[![build](https://github.com/remigermain/nested-multipart-parser/actions/workflows/main.yml/badge.svg)](https://github.com/remigermain/nested-multipart-parser/actions/workflows/main.yml)
4+
[![pypi](https://img.shields.io/pypi/v/nested-multipart-parser)](https://pypi.org/project/nested-multipart-parser/)
5+
36
Parser for nested data in multipart form, you can use it anyways, and you have a django rest framework integration
47

58
# Installation
@@ -8,7 +11,32 @@ Parser for nested data in multipart form, you can use it anyways, and you have a
811
pip install nested-multipart-parser
912
```
1013

11-
# Usage
14+
# How to use it
15+
16+
## for every framwork
17+
18+
```python
19+
from nested_multipart_parser import NestedParser
20+
21+
def my_view():
22+
parser = NestedParser(data)
23+
if parser.is_valid():
24+
validate_data = parser.validate_data
25+
...
26+
else:
27+
print(parser.errors)
28+
29+
```
30+
31+
## for django rest framwork
32+
33+
```python
34+
from nested_multipart_parser.drf import DrfNestedParser
35+
...
36+
37+
class YourViewSet(viewsets.ViewSet):
38+
parser_classes = (DrfNestedParser,)
39+
```
1240

1341
## What is doing
1442

@@ -22,7 +50,7 @@ exemple:
2250
'title': 'title',
2351
'date': "time",
2452
'simple_object[my_key]': 'title'
25-
'simple_object[my_list][0]': True
53+
'simple_object[my_list][0]': True,
2654
'langs[0][id]': 666,
2755
'langs[0][title]': 'title',
2856
'langs[0][description]': 'description',
@@ -157,31 +185,6 @@ for this working perfectly you need to follow this rules:
157185
}
158186
```
159187

160-
# How to use it
161-
162-
## for every framwork
163-
164-
```python
165-
from nested_multipart_parser import NestedParser
166-
167-
def my_view():
168-
parser = NestedParser(data)
169-
if parser.is_valid():
170-
validate_data = parser.validate_data
171-
...
172-
else:
173-
print(parser.errors)
174-
175-
```
176-
177-
## for django rest framwork
178188

179-
```python
180-
from nested_multipart_parser.drf import DrfNestedParser
181-
...
182-
183-
class YourViewSet(viewsets.ViewSet):
184-
parser_classes = (DrfNestedParser,)
185-
```
186-
## for frontend javscript
187-
You can use this [multipart-object](https://www.npmjs.com/package/multipart-object) library
189+
## Javscript
190+
You can use this [multipart-object](https://github.com/remigermain/multipart-object) library to easy convert object to flat nested object formated for this library

0 commit comments

Comments
 (0)