Skip to content

Commit 8d3cf98

Browse files
initial commit
0 parents  commit 8d3cf98

28 files changed

+1123
-0
lines changed

.gitignore

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
*.py[cod]
2+
3+
# C extensions
4+
*.so
5+
6+
# Packages
7+
*.egg
8+
*.egg-info
9+
dist
10+
build
11+
eggs
12+
parts
13+
sdist
14+
develop-eggs
15+
.installed.cfg
16+
17+
# Installer logs
18+
pip-log.txt
19+
20+
# Unit test / coverage reports
21+
.coverage
22+
.tox
23+
nosetests.xml
24+
htmlcov
25+
26+
# Translations
27+
*.mo
28+
29+
# Mr Developer
30+
.mr.developer.cfg
31+
.project
32+
.pydevproject
33+
34+
# Complexity
35+
output/*.html
36+
output/*/index.html
37+
38+
# Sphinx
39+
docs/_build

.travis.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Config file for automatic testing at travis-ci.org
2+
3+
language: python
4+
5+
python:
6+
- "3.3"
7+
- "2.7"
8+
9+
# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
10+
install: pip install -r requirements.txt
11+
12+
# command to run tests, e.g. python setup.py test
13+
script: python setup.py test

AUTHORS.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
=======
2+
Credits
3+
=======
4+
5+
* Simon Percivall <[email protected]>

CONTRIBUTING.rst

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/simonpercivall/django-dbshell-plus.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Any details about your local setup that might be helpful in troubleshooting.
21+
* Detailed steps to reproduce the bug.
22+
23+
Fix Bugs
24+
~~~~~~~~
25+
26+
Look through the GitHub issues for bugs. Anything tagged with "bug"
27+
is open to whoever wants to implement it.
28+
29+
Implement Features
30+
~~~~~~~~~~~~~~~~~~
31+
32+
Look through the GitHub issues for features. Anything tagged with "feature"
33+
is open to whoever wants to implement it.
34+
35+
Write Documentation
36+
~~~~~~~~~~~~~~~~~~~
37+
38+
Django DB Shell Plus could always use more documentation, whether as part of the
39+
official Django DB Shell Plus docs, in docstrings, or even on the web in blog posts,
40+
articles, and such.
41+
42+
Submit Feedback
43+
~~~~~~~~~~~~~~~
44+
45+
The best way to send feedback is to file an issueat https://github.com/simonpercivall/django-dbshell-plus/issues.
46+
47+
If you are proposing a feature:
48+
49+
* Explain in detail how it would work.
50+
* Keep the scope as narrow as possible, to make it easier to implement.
51+
* Remember that this is a volunteer-driven project, and that contributions
52+
are welcome :)
53+
54+
Get Started!
55+
------------
56+
57+
Ready to contribute? Here's how to set up `django_dbshell_plus` for local development.
58+
59+
1. Check out the repository.
60+
61+
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
62+
63+
$ flake8 django_dbshell_plus tests
64+
$ python setup.py test
65+
$ tox
66+
67+
To get flake8 and tox, just pip install them into your virtualenv.
68+
69+
6. Commit and send the patch or create a pull request.
70+
71+
Pull Request Guidelines
72+
-----------------------
73+
74+
Before you submit a pull request, check that it meets these guidelines:
75+
76+
1. The pull request should include tests.
77+
2. If the pull request adds functionality, the docs should be updated. Put
78+
your new functionality into a function with a docstring, and add the
79+
feature to the list in README.rst.
80+
3. The pull request should work for Python 2.7, and 3.3.

HISTORY.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
=========
2+
Changelog
3+
=========
4+
5+
Here's the recent changes to Django DB Shell Plus.
6+
7+
.. changelog::
8+
:version: dev
9+
:released: Ongoing
10+
11+
.. change::
12+
:tags: docs
13+
14+
Updated CHANGES.

LICENSE

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Copyright (c) 2015, Simon Percivall
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9+
10+
* Neither the name of Django DB Shell Plus nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11+
12+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst
6+
include requirements.txt
7+
include test_requirements.txt

Makefile

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.PHONY: clean-pyc clean-build docs clean
2+
3+
help:
4+
@echo "clean-build - remove build artifacts"
5+
@echo "clean-pyc - remove Python file artifacts"
6+
@echo "lint - check style with flake8"
7+
@echo "test - run tests"
8+
@echo "coverage - check code coverage quickly with the default Python"
9+
@echo "docs - generate Sphinx HTML documentation, including API docs"
10+
@echo "release - package and upload a release"
11+
@echo "sdist - package"
12+
13+
clean: clean-build clean-pyc
14+
rm -fr htmlcov/
15+
16+
clean-build:
17+
rm -fr build/
18+
rm -fr dist/
19+
rm -fr *.egg-info
20+
21+
clean-pyc:
22+
find . -name '*.pyc' -exec rm -f {} +
23+
find . -name '*.pyo' -exec rm -f {} +
24+
find . -name '*~' -exec rm -f {} +
25+
26+
clean-docs:
27+
rm -f docs/django_dbshell_plus*.rst
28+
29+
lint:
30+
flake8 lib/django_dbshell_plus tests
31+
32+
test:
33+
tox
34+
35+
coverage:
36+
tox -e coverage
37+
38+
docs:
39+
tox -e docs
40+
41+
dist: clean
42+
python setup.py sdist
43+
python setup.py bdist_wheel
44+
python setup.py bdist_egg
45+
ls -l dist

README.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
====================
2+
Django DB Shell Plus
3+
====================
4+
5+
.. This is an example of how the readme could be decorated with badges.
6+
.. image:: https://badge.fury.io/py/django_dbshell_plus.png
7+
:target: http://badge.fury.io/py/django_dbshell_plus
8+
9+
.. image:: https://travis-ci.org/<your github username>/django_dbshell_plus.png?branch=master
10+
:target: https://travis-ci.org/<your github username>/django_dbshell_plus
11+
12+
.. image:: https://pypip.in/d/django_dbshell_plus/badge.png
13+
:target: https://crate.io/packages/django_dbshell_plus?version=latest
14+
15+
16+
A dbshell_plus management command for Django that selects pgcli or mycli when available.
17+
18+
* Free software: BSD license
19+
* Documentation: http://django_dbshell_plus.rtfd.org.
20+
21+
Features
22+
--------
23+
24+
* TODO

0 commit comments

Comments
 (0)