Skip to content

Commit

Permalink
prepare 1.6; django 1.9 and 1.10 support
Browse files Browse the repository at this point in the history
  • Loading branch information
barseghyanartur committed Dec 13, 2016
1 parent 6abc5a1 commit b6875ce
Show file tree
Hide file tree
Showing 88 changed files with 1,650 additions and 1,380 deletions.
5 changes: 5 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[run]
omit =
src/admin_timeline/tests/*
example/simple/settings/*
example/simple/wsgi.py
19 changes: 12 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@
.hg/
.git/
.hgtags
/.coverage
/.cache/
/geckodriver.log
/ghostdriver.log

/example/db/
/example/tmp/
/example/media/static/
/example/media/_static/
/example/static/
/examples/db/
/examples/tmp/
/examples/logs/
/examples/media/static/
/examples/media/_static/
/examples/static/
/builddocs/
builddocs.zip
/builddocs.zip
/build/
/dist/
/src/admin_timeline.egg-info
/src/django_admin_timeline.egg-info
/MANIFEST.in~
/.tox/
/demos/
/releases/
/releases/
17 changes: 11 additions & 6 deletions .hgignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,17 @@ syntax: regexp
\.hgignore~
\.gitignore~
\.git/
\.coverage$
\.cache/v/cache/lastfailed
^geckodriver\.log$
^ghostdriver\.log$

^example/db/
^example/tmp/
^example/media/static/
^example/media/_static/
^example/static/
^examples/db/
^examples/tmp/
^examples/logs/
^examples/media/static/
^examples/media/_static/
^examples/static/
^builddocs/
^builddocs.zip
^build/
Expand All @@ -18,4 +23,4 @@ syntax: regexp
local_settings\.py
MANIFEST\.in~
^\.tox/
^releases/
^releases/
3 changes: 3 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[MASTER]
ignore=migrations,south_migrations,releases

30 changes: 27 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
Release history
===============
Release history and notes
=========================
`Sequence based identifiers
<http://en.wikipedia.org/wiki/Software_versioning#Sequence-based_identifiers>`_
are used for versioning (schema follows below):

.. code-block:: none
major.minor[.revision]
- It's always safe to upgrade within the same minor version (for example, from
0.3 to 0.3.4).
- Minor version changes might be backwards incompatible. Read the
release notes carefully before upgrading (for example, when upgrading from
0.3.4 to 0.4).
- All backwards incompatible changes are mentioned in this document.

1.6
---
Announcing dropping support of Python 2.6 and Django 1.7. As of 0.9.17
everything is still backwards compatible with Django 1.7, but in future
versions it will be wiped out.

- Django 1.9 and 1.8 compatibility.
- pep8 fixes.

1.5.4
-----
2015-10-02
Expand Down Expand Up @@ -68,4 +92,4 @@ Release history
---
2013-09-09

- Python 3.3.+ support
- Python 3.3 support
2 changes: 1 addition & 1 deletion LICENSE_GPL2.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

django-admin-timeline - A Facebook-like timeline app for Django admin.
Copyright (C) 2013-2015 Artur Barseghyan
Copyright (C) 2013-2016 Artur Barseghyan

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion LICENSE_LGPL_2.1.txt
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.

django-admin-timeline - A Facebook-like timeline app for Django admin.
Copyright (C) 2013-2015 Artur Barseghyan
Copyright (C) 2013-2016 Artur Barseghyan

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
Expand Down
97 changes: 60 additions & 37 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,39 +1,61 @@
===================================
=====================
django-admin-timeline
===================================
=====================
A Facebook-like timeline app for Django admin. It's very similar to built-in
feature `Daily progress`, but then has a nicer templates and infinite scroll
implemented. Actions are broken up by day, then by action. Filtering
by user (multiple select) and content type (multiple select) is implemented.

Prerequisites
===================================
- Django 1.4, 1.5, 1.6, 1.7, 1.8
- Python >=2.6.8, 2.7, 3.3
=============
Present
-------
Starting from ``django-admin-timeline`` 1.7:

- Django 1.8, 1.9, 1.10
- Python 2.7, 3.4, 3.5

Past
----
Current version of ``django-admin-timeline`` (1.6) has the following
prerequisites:

- Django 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10
- Python >=2.6.8, 2.7, 3.3, 3.4, 3.5

Dropping support of Django 1.4, 1.5, 1.6 and 1.7 has been announced in
version 1.6. As of 1.6 everything is still backwards compatible with
versions 1.4, 1.5, 1.6 and 1.7, but in future versions compatibility with
these versions will be wiped out.

Dropping support of Python 2.6 and 3.3 has been announced in version 1.6.
As of 1.6 everything is still backwards compatible with Python 2.6 and 3.3,
but in future versions compatibility with these versions will be wiped out.

Installation
===================================
1. Install in your virtual environemnt
============
1. Install in your virtual environment

Latest stable version from PyPI:

.. code-block:: none
.. code-block:: sh
$ pip install django-admin-timeline
pip install django-admin-timeline
Latest stable version from bitbucket:

.. code-block:: none
.. code-block:: sh
$ pip install -e hg+http://bitbucket.org/barseghyanartur/django-admin-timeline@stable#egg=django-admin-timeline
pip install -e hg+http://bitbucket.org/barseghyanartur/django-admin-timeline@stable#egg=django-admin-timeline
Latest stable version from github:

.. code-block:: none
.. code-block:: sh
$ pip install -e git+https://github.com/barseghyanartur/django-admin-timeline@stable#egg=django-admin-timeline
pip install https://github.com/barseghyanartur/django-admin-timeline/archive/stable.tar.gz
3. Add `admin_timeline` to your `INSTALLED_APPS` in the global settings.py.
3. Add ``admin_timeline`` to your ``INSTALLED_APPS`` in the
global ``settings.py``.

.. code-block:: python
Expand All @@ -43,14 +65,15 @@ Latest stable version from github:
# ...
)
4. Collect the static files by running (see the Troubleshooting section in case of problems):
4. Collect the static files by running (see the Troubleshooting section in
case of problems):

.. code-block:: none
.. code-block:: sh
$ ./manage.py collectstatic
./manage.py collectstatic
5. Override app settings in your global `settings` module (see the
`apps.admin_timeline.defaults` for the list of settings). As for now, most
``apps.admin_timeline.defaults`` for the list of settings). As for now, most
important of those is ``NUMBER_OF_ENTRIES_PER_PAGE`` - number of entries
displayed per page (for both non-AJAX and AJAX requests).

Expand All @@ -63,9 +86,9 @@ Latest stable version from github:
url(r'^admin/', include(admin.site.urls)),
Demo
===================================
====
Live demo
-----------------------------------
---------
See the `live demo app
<https://django-admin-timeline.herokuapp.com/admin/timeline/>`_ on Heroku.

Expand All @@ -75,26 +98,26 @@ Credentials:
- password: test

Run demo locally
-----------------------------------
In order to be able to quickly evaluate the `django-admin-timeline`, a demo
----------------
In order to be able to quickly evaluate the ``django-admin-timeline``, a demo
app (with a quick installer) has been created (works on Ubuntu/Debian, may
work on other Linux systems as well, although not guaranteed). Follow the
instructions below for having the demo running within a minute.

Grab the latest `django_admin_timeline_example_app_installer.sh`:
Grab the latest ``django_admin_timeline_example_app_installer.sh``:

.. code-block:: none
.. code-block:: sh
$ wget https://raw.github.com/barseghyanartur/django-admin-timeline/stable/example/django_admin_timeline_example_app_installer.sh
wget https://raw.github.com/barseghyanartur/django-admin-timeline/stable/example/django_admin_timeline_example_app_installer.sh
Assign execute rights to the installer and run the
`django_admin_timeline_example_app_installer.sh`:
``django_admin_timeline_example_app_installer.sh``:

.. code-block:: none
.. code-block:: sh
$ chmod +x django_admin_timeline_example_app_installer.sh
chmod +x django_admin_timeline_example_app_installer.sh
$ ./django_admin_timeline_example_app_installer.sh
./django_admin_timeline_example_app_installer.sh
Open your browser and test the app.

Expand All @@ -107,18 +130,18 @@ If quick installer doesn't work for you, see the manual steps on running the
<https://github.com/barseghyanartur/django-admin-timeline/tree/stable/example>`_.

Troubleshooting
===================================
===============
If somehow static files are not collected properly (missing admin_timeline.js
and admin_timeline.css files), install the latest stable version from source.

.. code-block:: none
.. code-block:: sh
$ pip install -e hg+http://bitbucket.org/barseghyanartur/django-admin-timeline@stable#egg=django-admin-timeline
Usage
===================================
=====
After following all installation steps, you should be able to access the
`django-admin-timeline` by:
``django-admin-timeline`` by:

http://127.0.0.1:8000/admin/timeline/

Expand All @@ -127,13 +150,13 @@ An example application is available. See the following directory:
https://github.com/barseghyanartur/django-admin-timeline/tree/stable/example

License
===================================
=======
GPL 2.0/LGPL 2.1

Support
===================================
For any issues contact me at the e-mail given in the `Author` section.
=======
For any issues contact me at the e-mail given in the `Author`_ section.

Author
===================================
======
Artur Barseghyan <artur.barseghyan@gmail.com>
Loading

0 comments on commit b6875ce

Please sign in to comment.