Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
nanvel committed Aug 17, 2013
0 parents commit 2ad2ad1
Show file tree
Hide file tree
Showing 16 changed files with 258 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.egg-info/
*.pyc
db.sqlite3
dist/
app_media/
7 changes: 7 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Current or previous core committers

Oleksandr Polyeno

Contributors (in alphabetical order)

* Your name could stand here :)
23 changes: 23 additions & 0 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
=== (ongoing) ===
- Initial commit


# Suggested file syntax:
#
# === (ongoing) ===
# - this is always on top of the file
# - when you release a new version, you rename the last `(ongoing)` to the new
# version and add a new `=== (ongoing) ===` to the top of the file
#
# === 1.0 ===
# - a major version is created when the software reached a milestone and is
# feature complete
#
# === 0.2 ===
# - a minor version is created when new features or significant changes have
# been made to the software.
#
# === 0.1.1 ==
# - for bugfix releases, fixing typos in the docs, restructuring things, simply
# anything that doesn't really change the behaviour of the software you
# might use the third digit which is also sometimes called the build number.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Nicedit widget for django with image upload feature.
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2013 Oleksandr Polyeno

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 7 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
include AUTHORS
include LICENSE
include DESCRIPTION
include CHANGELOG.txt
include README.rst
graft nicedit
global-exclude *.pyc
72 changes: 72 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Nicedit widget for Django
============

Nicedit widget for django with image upload feature.

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

To get the latest stable release from PyPi

.. code-block:: bash
$ pip install django-nicedit
To get the latest commit from GitHub

.. code-block:: bash
$ pip install -e git+git://github.com/nanvel/django-nicedit.git#egg=nicedit
TODO: Describe further installation steps (edit / remove the examples below):

Add ``nicedit`` to your ``INSTALLED_APPS``

.. code-block:: python
INSTALLED_APPS = (
...,
'nicedit',
)
Add the ``nicedit`` URLs to your ``urls.py``

.. code-block:: python
urlpatterns = patterns('',
...
url(r'^django-nicedit/', include('nicedit.urls')),
)
Don't forget to migrate your database

.. code-block:: bash
./manage.py migrate nicedit
Usage
-----

TODO: Describe usage or point to docs. Also describe available settings and
templatetags.


Contribute
----------

If you want to contribute to this project, please perform the following steps

.. code-block:: bash
# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 django-nicedit
$ python setup.py install
$ pip install -r dev_requirements.txt
$ git co -b feature_branch master
# Implement your feature and tests
$ git add . && git commit
$ git push -u origin feature_branch
# Send us a pull request for your feature branch
2 changes: 2 additions & 0 deletions nicedit/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
__version__ = '0.1'
11 changes: 11 additions & 0 deletions nicedit/admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
"""Admin classes for the nicedit app."""
# from django.contrib import admin

# from . import models


# class YourModelAdmin(admin.ModelAdmin):
# list_display = ['some', 'fields', ]
# search_fields = ['some', 'fieds', ]

# admin.site.register(models.YourModel, YourModelAdmin)
3 changes: 3 additions & 0 deletions nicedit/models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
"""Just an empty models file to let the testrunner recognize this as app."""
# from django.db import models
# from django.utils.translation import ugettext_lazy as _
Empty file added nicedit/tests.py
Empty file.
12 changes: 12 additions & 0 deletions nicedit/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
"""URLs for the nicedit app."""
# from django.conf.urls.defaults import patterns, url

# from . import views


# urlpatterns = patterns(
# '',
# url(r'^$',
# views.YourView.as_view(),
# name='nicedit_default'),
# )
8 changes: 8 additions & 0 deletions nicedit/views.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
"""Views for the nicedit app."""
# from django.views.generic import TemplateView

# from . import models


# class YourView(TemplateView):
# template_name = 'nicedit/default.html'
28 changes: 28 additions & 0 deletions runtests.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import sys

from django.conf import settings


def main():
settings.configure(
INSTALLED_APPS=(
'nicedit',
),
DATABASES={
'default': {
'ENGINE': 'django.db.backends.sqlite3',
}
},
SITE_ID=1,
)

from django.test.simple import DjangoTestSuiteRunner

test_runner = DjangoTestSuiteRunner(verbosity=1)
failures = test_runner.run_tests(['nicedit',])
if failures:
sys.exit(failures)


if __name__ == '__main__':
main()
58 changes: 58 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# -*- encoding: utf-8 -*-
"""
Python setup file for the nicedit app.
In order to register your app at pypi.python.org, create an account at
pypi.python.org and login, then register your new app like so:
python setup.py register
If your name is still free, you can now make your first release but first you
should check if you are uploading the correct files:
python setup.py sdist
Inspect the output thoroughly. There shouldn't be any temp files and if your
app includes staticfiles or templates, make sure that they appear in the list.
If something is wrong, you need to edit MANIFEST.in and run the command again.
If all looks good, you can make your first release:
python setup.py sdist upload
For new releases, you need to bump the version number in
nicedit/__init__.py and re-run the above command.
For more information on creating source distributions, see
http://docs.python.org/2/distutils/sourcedist.html
"""
import os
from setuptools import setup, find_packages
import nicedit as app


def read(fname):
try:
return open(os.path.join(os.path.dirname(__file__), fname)).read()
except IOError:
return ''

setup(
name="django-nicedit",
version=app.__version__,
description=read('DESCRIPTION'),
long_description=read('README.rst'),
license='The MIT License',
platforms=['OS Independent'],
keywords='django, nicedit, widget, rte',
author='Oleksandr Polyeno',
author_email='polyeno.com',
url="https://github.com/nanvel/django-nicedit",
packages=find_packages(),
include_package_data=True,
install_requires=[
'django',
'mock',
],
)
1 change: 1 addition & 0 deletions test_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mock

0 comments on commit 2ad2ad1

Please sign in to comment.