Skip to content

Commit

Permalink
preparation for pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
elky committed Mar 19, 2015
1 parent a48b236 commit d369ec7
Show file tree
Hide file tree
Showing 7 changed files with 114 additions and 82 deletions.
27 changes: 27 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2015, Alex Dergunov
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. 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.

3. Neither the name of the author nor the names of other contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS "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 <COPYRIGHT HOLDER> 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.
5 changes: 3 additions & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
recursive-include flat/static *
include README.md
recursive-include flat *
include README.rst
include LICENSE
57 changes: 0 additions & 57 deletions README.md

This file was deleted.

71 changes: 71 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
django-flat-theme
=================

Description
-----------

**django-flat-theme** brings fresh air to the default Django Admin
interface which hasn't changed 10 years from the very first version of
Django framework. This theme just makes UI modern and clean.

This app just overrides default admin's CSS. All changes are about
colors, margins, sizes. Nothing major.

**No any markup changes**.

Installation
------------

Install via pip:
``pip install django-flat-theme``

1. Put ``flat`` app in your *INSTALLED\_APPS* **before**
``django.contrib.admin``:

::

INSTALLED_APPS = (
...
'flat',
'django.contrib.admin',
...
)

2. That's it.

Compatibility
~~~~~~~~~~~~~

Works correct in Django 1.6+. Older Django versions use a slightly
different way to show icons, so it requires changing markup or adding
python logic to make this theme compatible.

Font
~~~~

This theme uses `Roboto <http://www.google.com/fonts/specimen/Roboto>`__
font which is under Apache 2.0 licence.

Testing
~~~~~~~

Tested in: - IE7+ (IE7 and IE8 are OK in terms of graceful degradation)
- FF30+ (Windows, Ubuntu, OSX) - Chrome 35+ (Windows, Ubuntu, OSX) -
Safari 8 (OSX)

Screenshot Examples
~~~~~~~~~~~~~~~~~~~

**Login page** |1|

**Dashboard** |2|

**List of objects** |3|

**New object** |4|

.. |1| image:: https://cloud.githubusercontent.com/assets/209663/6742228/df94018a-ceaf-11e4-8be8-5f31f01512d4.png
.. |2| image:: https://cloud.githubusercontent.com/assets/209663/6742227/df93dade-ceaf-11e4-9b88-aacf33b4eb3c.png
.. |3| image:: https://cloud.githubusercontent.com/assets/209663/6742226/df93e556-ceaf-11e4-98ad-7c5b4871fc04.png
.. |4| image:: https://cloud.githubusercontent.com/assets/209663/6742225/df938d5e-ceaf-11e4-8d3d-8968a9c76c99.png

2 changes: 1 addition & 1 deletion flat/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.1'
__version__ = '0.9.0'
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[metadata]
description-file = README.rst
32 changes: 10 additions & 22 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,27 +1,15 @@
import os

from setuptools import setup, find_packages

def read(fname):
return open(os.path.join(os.path.dirname(__file__), fname)).read()
from setuptools import find_packages, setup

setup(
name = "django-flat-theme",
version = __import__('flat').__version__,
author = "elky",
author_email = "mail@elky.me",
description = ("A flat theme for Django admin interface. Modern, fresh, simple."),
license = "BSD",
url = "https://github.com/elky/django-flat-theme",
name = 'django-flat-theme',
packages = find_packages(),
version = __import__('flat').__version__,
author = 'Alex D',
author_email = 'mail@elky.me',
description = ('A flat theme for Django admin interface. Modern, fresh, simple.'),
license = 'BSD',
url = 'https://github.com/elky/django-flat-theme',
download_url = 'https://github.com/elky/django-flat-theme/tarball/0.9.0',
keywords = ['testing', 'logging', 'example'],
include_package_data = True,
long_description = read('README.md'),
zip_safe = False,
classifiers = [
"Development Status :: 3 - Alpha",
'Environment :: Web Environment',
'Operating System :: OS Independent',
"Topic :: Utilities",
"License :: OSI Approved :: BSD License",
],
)

0 comments on commit d369ec7

Please sign in to comment.