Welcome to django-shells’s documentation!¶
Contents:
django-shells¶
Better shells for your manage.py.
Documentation¶
The full documentation is at https://django-shells.readthedocs.org.
Quickstart¶
Install django-shells:
pip install django-shells
Then add 'shells' to your INSTALLED_APPS.
Features¶
- TODO
Usage¶
To use django-shells, add 'shells' in your INSTALLED_APPS. This replaces the shell and dbshell management commands with a customised version.
The shell Command¶
The new shell command adds two choices as your Python shell: ptpython and ptipython. Both requires you to install Jonathan Slender’s ptpython, and the latter also requires IPython.
The interpreter is chosen automatically based on what your environment has. All command line options are identical to the built-in shell command, except that the --interface (and the -i shorthand) supports two additional values ptpython and ptipython.
The dbshell Command¶
Two additional database clients are added: pgcli for PostgreSQL, and mycli for MySQL. Both require you to install a Python package with the same name.
The client is chosen automatically based on your database settings, and what your environment provides. You can also use the --plain and --interface (shorthanded -i) options to specify one explicitly.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/uranusjr/django-shells/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
django-shells could always use more documentation, whether as part of the official django-shells docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/uranusjr/django-shells/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up django-shells for local development.
Fork the django-shells repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/django-shells.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv django-shells $ cd django-shells/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8:
$ flake8 shells
To get flake8, just pip install it into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.7, 3.3 onwards, and for PyPy.
Credits¶
Contributors¶
- Tzu-ping Chung <uranusjr@gmail.com>