README cleanup

This commit is contained in:
Daniel Greenfeld 2013-07-14 11:21:30 +02:00
parent d2741ced7b
commit 8853a0423d
4 changed files with 102 additions and 93 deletions

83
HISTORY.rst Normal file
View file

@ -0,0 +1,83 @@
History
=========
0.5.1 (2013-07-08)
* Added django-filter to dependency list
* Problem with related_name resolved
* Fixed the height of the change_form
* FAQ added
0.5.0 (2013-07-08)
* Implemented customizable value renderers
* Implemented list filters using django-filters. Greatly supersedes what Django provides.
* Implemented ModelAdmin2.save_on_top and ModelAdmin2.save_on_bottom
* Implemented BooleanField icons for List and Detail views
* Implemented default ``django.contrib.auth`` and ``django.contrib.sites`` registrations
* Implemented the displayed of verbose field/method names in list view
* Implemented client-side ordering of model list fields in default theme
* Implemented improved internal naming conventions
* Improved example project home page
* Improved internal test coverage
* Documentation for Context Variables in Themes
* Corrected early nomenclature decisions
* Much improved Internationalization
* Added django-admin2 to Transifex
* Translations for French, Polish, Slovak, Chinese, German, Catalan, Italian, and Spanish.
0.4.0 (2013-06-30)
* Implemented both Function- and Class-based Action views
* Implemented ModelAdmin2.list_display
* Implemented ModelAdmin2.fieldsets
* Dropdown widget now displays the selected choice
* Added support for callables in ModelAdmin2.list_display
* Added screenshots to README
* Added second example project
* Fixed breadcrumbs
* Default theme: Proper closing of template and media blocks
* Default theme: Standardized indentation in default theme templates
* Default theme: Pointed to CDN for JQuery
* Default theme: Added basic style for login form
* Default theme: Internationalized all text strings
0.3.0 (2013-05-31)
* HTML5 forms via floppyforms.
* Many API improvements.
* Added Breadcrumbs.
* Added Login, Logout, ChangePassword views.
* Added Actions.
* Added support for inlines.
* Added view based permission controls
* Implement delete confirmations for child models.
* Testrunner now can run on a specific test set or module.
* Internal code refactoring to follow standards.
* Moved to git-flow for accepting pull requests.
* Model create/update pages now have save options.
* Added i18n to all templates, much of internal code.
* All print statements replaced with proper logging.
* Design goals specified in the documentation.
0.2.0 (2013-05-19)
* Birth! (Working Prototype)
* Easy-to-extend API that follows similar patterns to django.contrib.admin.
* Built-in RESTFUL API powered by django-rest-framework.
* Default theme built on Twitter Bootstrap.
* Easy to implement theme system.
* Basic permission controls.
* Testrunner
* Documentation
0.1.1 (2013-05-17)
* Code adoption from django-mongonaut.
* Preperation for Django Circus sprints.
0.1 (2013-05-13)
* Discussion with Russell Keith-Magee.
* Inception.

View file

@ -28,21 +28,7 @@ Features
* Drop-in themes
* Built-in RESTful API
Screenshots
===========
.. image:: screenshots/Site_administration.png
:width: 722px
:alt: Site administration
:align: center
:target: screenshots/Site_administration.png
.. image:: screenshots/Select_user.png
:width: 722px
:alt: Select user
:align: center
:target: screenshots/Select_user.png
.. include:: SCREENSHOTS.rst
Requirements
=============
@ -53,12 +39,14 @@ Requirements
* django-extra-views_
* django-floppyforms_
* django-rest-framework_
* django-filter_
* Sphinx_ (for documentation)
.. _django-braces: https://github.com/brack3t/django-braces
.. _django-extra-views: https://github.com/AndrewIngram/django-extra-views
.. _django-floppyforms: https://github.com/brutasse/django-floppyforms
.. _django-rest-framework: https://github.com/tomchristie/django-rest-framework
.. _django-filter: https://github.com/alex/django-filter
.. _Sphinx: http://sphinx-doc.org/
@ -148,80 +136,3 @@ If you create a new theme, you define it thus:
ADMIN2_THEME_DIRECTORY = "djadmin2/foundation/"
History
=========
0.5.0 (pending)
* Implemented customizable value renderers
* Implemented list filters using django-filters. Greatly supersedes what Django provides.
* Implemented ModelAdmin2.save_on_top and ModelAdmin2.save_on_bottom
* Implemented BooleanField icons for List and Detail views
* Implemented default ``django.contrib.auth`` and ``django.contrib.sites`` registrations
* Implemented the displayed of verbose field/method names in list view
* Implemented client-side ordering of model list fields in default theme
* Implemented improved internal naming conventions
* Improved example project home page
* Improved internal test coverage
* Documentation for Context Variables in Themes
* Corrected early nomenclature decisions
* Much improved Internationalization
* Added django-admin2 to Transifex
* Translations for French, Polish, Slovak, Chinese, German, Catalan, Italian, and Spanish.
0.4.0 (2013-06-30)
* Implemented both Function- and Class-based Action views
* Implemented ModelAdmin2.list_display
* Implemented ModelAdmin2.fieldsets
* Dropdown widget now displays the selected choice
* Added support for callables in ModelAdmin2.list_display
* Added screenshots to README
* Added second example project
* Fixed breadcrumbs
* Default theme: Proper closing of template and media blocks
* Default theme: Standardized indentation in default theme templates
* Default theme: Pointed to CDN for JQuery
* Default theme: Added basic style for login form
* Default theme: Internationalized all text strings
0.3.0 (2013-05-31)
* HTML5 forms via floppyforms.
* Many API improvements.
* Added Breadcrumbs.
* Added Login, Logout, ChangePassword views.
* Added Actions.
* Added support for inlines.
* Added view based permission controls
* Implement delete confirmations for child models.
* Testrunner now can run on a specific test set or module.
* Internal code refactoring to follow standards.
* Moved to git-flow for accepting pull requests.
* Model create/update pages now have save options.
* Added i18n to all templates, much of internal code.
* All print statements replaced with proper logging.
* Design goals specified in the documentation.
0.2.0 (2013-05-19)
* Birth! (Working Prototype)
* Easy-to-extend API that follows similar patterns to django.contrib.admin.
* Built-in RESTFUL API powered by django-rest-framework.
* Default theme built on Twitter Bootstrap.
* Easy to implement theme system.
* Basic permission controls.
* Testrunner
* Documentation
0.1.1 (2013-05-17)
* Code adoption from django-mongonaut.
* Preperation for Django Circus sprints.
0.1 (2013-05-13)
* Discussion with Russell Keith-Magee.
* Inception.

14
SCREENSHOTS.rst Normal file
View file

@ -0,0 +1,14 @@
Screenshots
===========
.. image:: https://github.com/pydanny/django-admin2/raw/develop/screenshots/Site_administration.png
:width: 722px
:alt: Site administration
:align: center
:target: https://github.com/pydanny/django-admin2/raw/develop/screenshots/Site_administration.png
.. image:: https://github.com/pydanny/django-admin2/raw/develop/screenshots/Select_user.png
:width: 722px
:alt: Select user
:align: center
:target: https://github.com/pydanny/django-admin2/raw/develop/screenshots/Select_user.png

View file

@ -60,12 +60,13 @@ if sys.argv[-1] == 'publish':
sys.exit()
LONG_DESCRIPTION = open('README.rst').read()
HISTORY = open('HISTORY.rst').read()
setup(
name='django-admin2',
version=version,
description="An introspective interface for Django's ORM.",
long_description=LONG_DESCRIPTION,
long_description=LONG_DESCRIPTION + '\n\n' + HISTORY,
classifiers=[
"Development Status :: 3 - Alpha",
"Environment :: Web Environment",