Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmad88me committed Sep 17, 2023
1 parent e369a89 commit edb9d55
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This generates a fully functioning apis using generated serializers and class-vi
1. Install it in your django project `pip install django-rest-gen`.
2. Run it and specify your app `python -m django-rest-gen`. You should also
specify the appropriate arguments (e.g., ` python -m django-rest-gen --settings iires/settings.py --apppath iirapp`)
*Note: if the file already exists and is not empty, the content will be printed instead in the stdout*

## Arguments
```
usage: django-rest-gen [-h] [--pythonpath PYTHONPATH] --settings SETTINGS --apppath APPPATH [--views VIEWS]
Expand All @@ -24,3 +26,8 @@ optional arguments:

# Limitations
* Flat. No nesting is provided as it depends on user preferences.


# Rebuild package
1. `python3 -m build`
2. `python3 -m twine upload dist/*`

0 comments on commit edb9d55

Please sign in to comment.