Metadata-Version: 2.1
Name: django-shts3
Version: 4.3
Summary: Start Django dev server faster
Home-page: https://gitlab.com/q_wolphin/django-shts3
Author: Wolphin
Author-email: wolphin@wolph.in
License: UNKNOWN
Description: # Django shortcuts
        
        **You spend too much time typing `python3 manage.py`**
        
        [![badge](https://badge.fury.io/py/django-shts3.svg)](https://pypi.python.org/pypi/django-shts3)
        
        The tool is already used by [Uptrader](https://uptrader.io/) team for more then a year
        
        It's a fork of [django-shortcuts](https://github.com/jgorset/django-shortcuts) by [Johannes Gorset](https://github.com/jgorset)
        
        ### Key improvements:
        - Python 3 support (but no support for Python 2)
        - config file for user-defined shortcuts
        - support for python flags
        
        ## Installation
        
        ```
        $ pip3 install django-shts3
        ```
        
        ## What problem does the helper script address
        
        The tool allows much shorter commands when using Django's `manage.py` script
        
        #### Raw command
        
        ```bash
        python3 manage.py shell
        ```
        
        #### Command with `django-shts3` helper
        
        ```bash
        d s
        ```
        
        Unlike raw command, the helper script can be called from any project subdirectory, not only from project root. 
        
        ## Usage
        
        PyPi package installs `django` and `d` binaries
        All arguments with `-` at the begining before command are threated as Python flags.
        
        ```
        $ django <command or shortcut>
        
        $ cd any/project/subdirectory
        $ d <command or shortcut>
        ```
        
        ## Default shortcuts
        
        Alias   | Command
        --------|---------------
        c       | collectstatic
        r       | runserver
        s / sh  | shell
        t       | test
        m       | migrate
        mkm     | makemigrations
        csu     | createsuperuser
        cpw     | changepassword
        sa      | startapp
        sp      | startproject
        
        ## Configuration file
        
        The program looks for `.django_shts3` file in home directory and loads extra commands from it.
        They overwrite default commands. File format is:
        
        ```
        alias @@@ command
        m @@@ migrate
        ```
        
        ### Example:
        
        I have docker container with Django and I should bind to 0.0.0.0:8000 on runserver command, so I have:
        
        ```
        $ cat ~/.django_shts3
        r @@@ runserver 0.0.0.0:8000
        ```
        
        That allows me to start Django server like:
        
        ```
        $ d r
        ```
        
        Or same thing, but with deprication warnings:
        
        ```
        $ d -Wd r
        ```
        
        ## Contributing
        
        Pull requests are welcome!
        
        Report all problems to [GitLab issues](https://gitlab.com/q_wolphin/django-shts3/issues)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
