update doc files, initial release to PyPI

Author: jontsai

AUTHORS.md

@@ -0,0 +1,7 @@
+=======
+Credits
+=======
+
+* Simon Percivall <[email protected]>
+* Jonathan Tsai <[email protected]>
+* Hacktoolkit <[email protected]>

AUTHORS.rst

@@ -1,48 +1,40 @@
-============
-Contributing
-============
+# 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
-----------------------
+## Types of Contributions
 
-Report Bugs
-~~~~~~~~~~~
+### Report Bugs
 
-Report bugs at https://github.com/simonpercivall/django-dbshell-plus.
+Report bugs at https://github.com/hacktoolkit/django-dbshell-plus.
 
 If you are reporting a bug, please include:
 
 * Any details about your local setup that might be helpful in troubleshooting.
 * Detailed steps to reproduce the bug.
 
-Fix Bugs
-~~~~~~~~
+### Fix Bugs
 
 Look through the GitHub issues for bugs. Anything tagged with "bug"
 is open to whoever wants to implement it.
 
-Implement Features
-~~~~~~~~~~~~~~~~~~
+### Implement Features
 
 Look through the GitHub issues for features. Anything tagged with "feature"
 is open to whoever wants to implement it.
 
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
+### Write Documentation
 
 Django DB Shell Plus could always use more documentation, whether as part of the 
 official Django DB Shell Plus docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
-Submit Feedback
-~~~~~~~~~~~~~~~
+### Submit Feedback
 
-The best way to send feedback is to file an issueat https://github.com/simonpercivall/django-dbshell-plus/issues.
+The best way to send feedback is to file an issue at https://github.com/hacktoolkit/django-dbshell-plus.
 
 If you are proposing a feature:
 
@@ -51,8 +43,7 @@ If you are proposing a feature:
 * Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
-Get Started!
-------------
+## Get Started!
 
 Ready to contribute? Here's how to set up `django_dbshell_plus` for local development.
 
@@ -67,8 +58,7 @@ Ready to contribute? Here's how to set up `django_dbshell_plus` for local develo
 
 6. Commit and send the patch or create a pull request.
 
-Pull Request Guidelines
------------------------
+## Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:
 

CONTRIBUTING.rst renamed to CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Changelog
+
+Here's the recent changes to Django DB Shell Plus.
+
+---
+
+Version: 2.0.0
+Released: 2024-06-20
+
+Updates for Python 3
+
+---
+
+Version: 1.0.1
+Released: 2015-08-12
+
+Initial version, use `pgcli` or `mycli` when available.
+
+---
+

HISTORY.md

@@ -1,38 +1,47 @@
 .PHONY: clean-pyc clean-build docs clean
 
+## help - Display help about make targets for this Makefile
 help:
-	@echo "clean-build - remove build artifacts"
-	@echo "clean-pyc - remove Python file artifacts"
-	@echo "lint - check style with flake8"
-	@echo "coverage - check code coverage quickly with the default Python"
-	@echo "docs - generate Sphinx HTML documentation, including API docs"
-	@echo "release - package and upload a release"
-	@echo "sdist - package"
+	@cat Makefile | grep '^## ' --color=never | cut -c4- | sed -e "`printf 's/ - /\t- /;'`" | column -s "`printf '\t'`" -t
 
+## clean - remove all build, test, coverage and Python artifacts
 clean: clean-build clean-pyc clean-docs
 	rm -fr htmlcov/
 
+## clean-build - remove build artifacts
 clean-build:
 	rm -fr build/
 	rm -fr dist/
 	rm -fr *.egg-info
 
+## clean-pyc - remove Python file artifacts
 clean-pyc:
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '*.pyo' -exec rm -f {} +
 	find . -name '*~' -exec rm -f {} +
 
+## clean-docs - remove generated docs
 clean-docs:
 	rm -f docs/django_dbshell_plus*.rst
 
+## coverage - check code coverage quickly with the default Python
+coverage:
+
+## lint - check style with flake8
 lint:
 	flake8 lib/django_dbshell_plus
 
+## docs - generate Sphinx HTML documentation, including API docs
 docs:
 	tox -e docs
 
+## dist - package
 dist: clean
 	python setup.py sdist
 	python setup.py bdist_wheel
 	python setup.py bdist_egg
 	ls -l dist
+
+## release - package and upload a release
+release: dist
+	sh -c "twine upload dist/*.whl dist/*.tar.gz --verbose"

HISTORY.rst

@@ -1,18 +1,14 @@
-====================
-Django DB Shell Plus
-====================
+# Django DB Shell Plus
 
 **NOTE:**
 This is a fork from
 https://github.com/simonpercivall/django-dbshell-plus, which has not
 been maintained for over 9 years.
 
 
-.. image:: https://badge.fury.io/py/django_dbshell_plus.png
-    :target: http://badge.fury.io/py/django-dbshell-plus
+[https://badge.fury.io/py/htk_django_dbshell_plus.png](http://badge.fury.io/py/htk-django-dbshell-plus)
 
-.. image:: https://pypip.in/d/django_dbshell_plus/badge.png
-    :target: https://crate.io/packages/django-dbshell-plus?version=latest
+[https://pypip.in/d/htk_django_dbshell_plus/badge.png](https://crate.io/packages/htk-django-dbshell-plus?version=latest)
 
 
 A dbshell_plus management command for Django that selects `pgcli` or `mycli` when available.

Makefile

@@ -2,10 +2,11 @@
 # -*- coding: utf-8 -*-
 import os
 import re
-from setuptools import setup, find_packages
 
-readme = open('README.rst').read()
-history = open('HISTORY.rst').read().replace('.. :changelog:', '')
+from setuptools import find_packages, setup
+
+readme = open('README.md').read()
+history = open('HISTORY.md').read().replace('# Changelog', '')
 
 
 def read_reqs(name):
@@ -24,13 +25,13 @@ def read_version():
 # NB: _don't_ add namespace_packages to setup(), it'll break
 #     everything using imp.find_module
 setup(
-    name='django-dbshell-plus',
+    name='htk-django-dbshell-plus',
     version=read_version(),
     description='A dbshell_plus management command for Django that selects pgcli or mycli when available.',
     long_description=readme + '\n\n' + history,
-    author='Simon Percivall',
-    author_email='percivall@gmail.com',
-    url='https://github.com/simonpercivall/django-dbshell-plus',
+    author='Hacktoolkit',
+    author_email='hello@hacktoolkit.com',
+    url='https://github.com/hacktoolkit/django-dbshell-plus',
     packages=find_packages('lib'),
     package_dir={'': 'lib'},
     include_package_data=True,
@@ -43,10 +44,6 @@ def read_version():
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
         'Natural Language :: English',
-        "Programming Language :: Python :: 2",
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
     ],
 )